Simplify interface development with Apidoc

As programmers hate to see the code without comments, their own code hate to write comments, feel trouble, the interface is the same.

For example, the company to do a H5 activity page, development documents have been sent to the backend development, design, and the front-end mailbox, in fact, this time can begin to develop. The developer begins to demonstrate whether the logic in the H5 page can be implemented, the logic is reasonable, and timely feedback is given to the product for modification or optimization. When everything is set down, all aspects of the work can begin.

In general, design resources are given before the backend interface development is complete. For a back-end engineer who is good enough for the development work, generally see the design draft, know the interface data structure and internal logic is how. So you don't have to wait until the interface is really developed, just give the front-end classmates.

This way front-end classmates and back-end classmates, can be developed in parallel. For example, a H5 activity page needs 1 weeks to complete, now only 4 days, save two days, the programmer can be used to improve their skills and to rest.

However, people are inert. The development of the time is not willing to write documents, especially interface documents, feel very troublesome. My colleagues, sometimes do not bother to write interface documents, the front-end students based on the interface returned data to develop, sometimes the interface returned data error, the front-end does not know the correct interface data is what, will be delayed development time, could have completed work on schedule, the results in the docking interface spent too much time.

In a lot of interface development work, I used a lot of document tools, such as the Markdown tool (the mark flying image), and the other is the Apidoc document generation tool. Markdown Grammar Most of the students who have written the program know, more useful, suitable for writing a blog or something, you can put the focus of writing on the content, rather than the format. However, it may not be appropriate for Markdown to write an interface document. Interface documents require rich formatting to build hierarchies, and tables to load parameters. When there are many interfaces, you also need to classify the interfaces, and you need to have the ability to retrieve the interfaces. Another pain point is, for example, the back-end PHP development classmate wrote a markdown document, to the front-end classmate, or the client, but also to remind them how to use. Not everyone has a markdown parser installed on their computers. This is very annoying, fortunately apidoc solved this thorny problem.

It took a long time to summarize several advantages of Apidoc:

1, easy installation, fool-type installation

2, interface document syntax is very simple, do not need to increase the cost of memory, writing interface documents is very easy, no longer spend a lot of time, but to copy and paste

3, the generated document format is beautiful, and practical, to meet the developer of the various requirements of the interface.

Since this article is not about Apidoc's tutorial documentation, it is the most practical thing to say, such things, or official documents. Parameters so much, do not need to take a small book down, when needed, to the official online copy and paste can, with more, natural commonly used will be written down. Attach a apidoc to generate the document:

Simplify interface development with Apidoc