Why write interface documentation?

Interface documentation is very important for formal team work or project docking, and is usually written by developers. A neat document is unimportant. In the process of project development, the front and back end engineers have a unified file for communication and development. During project maintenance or project personnel change, it is convenient for later personnel to view and maintainCopy the code

Second, the format of the interface document

Interfaces are divided into four parts: methods, URIs, request parameters, and return parameters

Interface document generation tool

Apipost is a great tool for interface testing. It can generate interface documents in various formats, including online version, Markdown format and Word format.

Click Share current interface

share

The copy link opens in your browser

Download interface documentation in other formats

Interface document in Word format (Word only supports typesetting in JSON format, so the data format returned by Baidu is not standardized in Word)

The word format interface document of a single interface can be downloaded for free, and the time of downloading multiple simple documents and interface documents of a project requires membership.

Also, when apiPost downloads multiple Interface documents in Word format, each interface is a separate interface document that needs to be merged. WPS and Office have merge functions.

Find the text in the file in the inserted object and click Select All interfaces to merge.

This is the interface document generation tool apiPost