How to reduce the cost of API documentation

The API is the core component of the application, and the API documentation records in detail how to use the application, and when there is a problem with the application, it helps technicians quickly locate the problem. A complete API document should consider all aspects of the API, even the handover work of API development.

When the personnel flow in the team, the docking work is a headache. Before finding the docking person, multiple departments need to be involved. After finding the docking person, it is also necessary to transfer the work task content to the docking person. For documents such as API documents that involve a wide range and relatively detailed content, if the API document itself has defects, the docking cost will be greatly increased.

Use Office tools to record API

Some teams use the Office document logging API. Although Office is a powerful document tool, typesetting is a big problem. In the early stage of using Office to record API documents, you need to typeset the documents well. However, the maintenance of Office is difficult, and once it needs to be handed over, explanation will become difficult. If the typesetting is inappropriate or the document maintenance is problematic, as the number of APIs increases, the difficulty and cost of maintenance will be higher.

Use API document management tool to record API

The advantage of using API documentation tools is that the documentation is highly readable, easy to maintain, and detailed.

At present, there are many API documentation tools in the market, among which tools with clear interfaces and complete functions include Postman, Swagger, and Eolinker. Postman can record APIs and has powerful testing functions, but it is biased towards testing and is no better than Swagger and Eolinker in terms of documentation. Swagger documents should be familiar to you, and the interface colors are nice. Eolinker is suitable for enterprises of all sizes. This article uses Eolinker to demonstrate. When the API tool displays the API, it can not only include the basic information of the API, such as request parameters, url, etc., but also view the status and examples of the API. Eolinker can also view the change history and compare the change history.

Use the API management tool for docking, you only need to instruct the docking person how to view the API document, the interface is all visual operation, so the use and maintenance are relatively simple.

If you have a team that intends to keep API documentation simple and easy to connect, you can try to use API management tools for API management. They are not only documentation tools, but also powerful testing functions. Demonstration tool use address: www.eolinker.com

Guess you like

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