1. Why write interface documentation?
1. For formal teamwork or project docking, interface documentation is very important. Generally, interface documentation is written by developers. A neat document appears right and wrong.
2. During the project development process, front-end and back-end engineers have a unified document for communication and development. Project maintenance or project personnel change is convenient for later personnel to view and maintain
Second, the format of the interface document
The interface is mainly divided into four parts: method, uri, request parameter, return parameter
3. Interface document generation tool
apipost is a very good interface testing tool, it can generate interface documents in various formats, online version, markdown format and Interface document in word format.
Click to share the current interface to
share and
copy the link to open
the interface document in other formats in the browser to download the interface document in
word format (word only supports json format, so the data format returned by Baidu is not standardized in word) word of
a single interface The format of the interface document can be downloaded for free, and the time to download multiple simple documents and the interface document of a project requires opening a membership.
Also, when apipost downloads multiple interface documents in word format, each interface is a separate interface document that needs to be merged. There are merge functions in wps and office.
Find the text in the file in the object being inserted and click to select all interfaces to merge.
This is the
download address of the interface document generation tool apipost:https://www.apipost.cn/?dt=20201028