current position:Home>How to quickly and easily generate good-looking interface documents (API post generated documents)

How to quickly and easily generate good-looking interface documents (API post generated documents)

2021-08-27 07:45:18 It's me 88711

One click document generation

We are “2 Minutes to play APIPOST” Talk about , It briefly introduces how to generate and share interface documents :

Click share document



Copy and open the document address to see the complete interface document .

This lesson is mainly to explain some matters needing attention .

Fill in the description of the request parameters

about header、query as well as form-data and urlencode Of body Parameters , Let's fill in the parameter description in the following places :

As shown in the picture , For a filled parameter , We can create a new interface by clicking the following... In the parameter description ️ Box flag quick import description , Don't repeat typing .

about raw Type of body Parameters , We can click “ Extract fields and descriptions ” To describe the parameters :

For the parameters that have been filled in ,APIPOST Will automatically match the description , There is no need to fill in .

Fill in the description of response parameters

Many novices wonder why APIPOST There are no successful response examples and error response examples for the shared document , That's because APIPOST The sent real-time response data will not be used as a response example .

You need to manually import or copy the real-time response results to the corresponding successful response examples and error response examples .

Fill in the field description with raw Type of body Parameters , We can click “ Extract fields and descriptions ” To describe the parameters .

Again , For the parameters that have been filled in ,APIPOST Will automatically match the description , There is no need to fill in .

copyright notice
author[It's me 88711],Please bring the original link to reprint, thank you.
https://en.qdmana.com/2021/08/20210827074517065J.html

Random recommended