API Documentation is often a developer's nightmare . Relative and development tasks , Sometimes writing documents is more complicated , There are more to consider . A good document can be read by the writer himself , The rest of the team 、 Operation team, etc , Even some open ones API requirement API The document can be read by users .
Why write API The documentation is so cumbersome
In order to make API Documents are standardized and easy to change , from API There must be a standard rule to start with , Current design API Most use restful API style , Include in API Basic information （ Request method 、 Requester, etc ） At the same time , The following points should also be included ：
API An overview of the design principles of . explain API The role of , With the meaning of each request message .
API Invoke the sample .API Call examples are an important part of the document , It can help us understand that API And quickly learn how to call the API.
API edition . Product update at the same time API The version needs to be iterated , Record each API Version is convenient and quick to manage the product .
in summary , To write API Documentation is a chore , The writer should not only be familiar with API The role of , We also need to think about how to perfect it from different angles API file .
API The benefits of documentation
Since it was written API The documentation is so cumbersome , Why invest resources to improve ？ It's the so-called great responsibility of heaven to the people , We must work hard first , Work hard … For writing API This is also true of documents ,API The continuous standardization of documents brings a lot of benefits to the later work ,API Document as API Use guide , Will help developers in the team to build products together ,API Documentation is also convenient for test runs API The quality of the , Help to enhance the direct communication efficiency of the development team .
API Documentation tool
API Documentation tools make API It's not as tedious as a document , It provides API Various conditions required by the document , The document looks simple and beautiful , Convenient for internal developers to view at the same time , It can also be shared with users . Excellent document tools provide personnel rights management , Assign permissions to members of different departments , It is conducive to the interaction and cooperation of the whole team … In order to be able to API Effective management of the whole life cycle ,Eolinker It's a good choice .
Use the address ：www.eolinker.com