API online documentation

API documentation is often used to help project members collaborate, test, or provide users for reference. How to share API documents gracefully, using tools is a good choice. There are many online API documentation tools, such as: Swagger, SosoAPI, Eolinker, Showdoc, etc. Currently, Eolinker is used in work. In Eolinker, you can share the project online to people outside the team, and others can view the API documentation online and conduct API testing through the sharing link. You do not need to register an account to view API documents in this way, which is convenient for viewing interface documents and testing interfaces. Go to the API management project overview page and click the online sharing project settings to enable or disable the project online sharing function.

It can be turned on and off at any time. After sharing, support can be easily provided to those who want to share to view without logging in. If you need to access the support setting password, you can set it as shown in the figure below:

You can also set the operations that visitors are allowed to perform: view API documents, conduct API tests, view status code documents, view project documents, etc. For example: You can view [Detailed API Document], [Initiate API Test], [View Mock API], [View Status Code Document], [View Project Document], and also view the information of [Project Environment].

View API documentation:

Initiate API test: Initiate test on API at any time, check API

View mock: Display various expectations and simulate actual return data

Status code documentation: Indicate the meaning of various return status codes

Switch environment: After opening, you can view the project environment, and visitors can see the environment switching menu at the top right of the project sharing page. Set the project environment information that visitors can see, such as development environment, test environment, production environment, etc. request address prefix information, etc. The default environment is not switchable.

Project documents: various text descriptions, pictures, files, etc. attached to the project

API tools improve the flexibility of the project. Choosing the right API management tools can help us better manage the project process. Eolinker: www.eolinker.com

Guess you like

Origin blog.csdn.net/qq_40857096/article/details/112727218