Interface documentation is a necessary documentation in the development of a project, but it is quite laborious to write interface documentation. This article recommends a particularly useful interface document generation tool, ApiPost
Apipost is a domestic tool for interface testing and interface document generation. Its interface document generation function is particularly powerful.
Open the APIPost to write a login interface request
It has two functions here, the success response sample and documentation and the error response sample and documentation
Successful response sample document, we click import and export fields from existing response results to get the image shown
Share a Document View a Document
You can also add an error response sample document
Share views, and both successful and failed response examples appear
It also supports interface documents in HTML, Markdown, and Word formats
Take a look at the interface document in Word format (Word only generates the sample document for the successful response)
This is how apiPost generates the interface document
Download address:
ApiPost – an API debugging and management tool that generates documentation directly www.apipost.cn icon