Apifox generates interface documentation tutorial and operation steps

Interface documentation is automatically generated

This article mainly introduces how to use apifox to generate interface documents, and attaches detailed usage tutorials and operation steps.

Use Apifox to automatically generate interface documentation.This article will show you how to use Apifox to automatically generate the required interface documentation.

Apifox is an interface design, debugging, testing and document management tool that can generate beautiful and concise structured interface documents, and the interface documents also support online debugging, mocking, and code generation.

The effect of the generated interface document is as follows:

You can copy the link to the browser to view the generated online documentation, and have an intuitive experience of the features of this interface documentation tool:

https://www.apifox.cn/apidoc/shared-cbb5c14c-0faa-4b4d-9f6e-7027cd57c702/api-21636796

How to generate interface documentation with Apifox

1. To sum up, it needs to be divided into 3 steps:

1. Design interface documents, fill in parameters such as interface methods, requests and responses, and save them

2. Export interface documents with one click, set sharing parameters, and send links to partners

3. Content Update

The first step: create a new interface and fill in the information

Fill in the method, path, request parameters and response parameters of the interface to generate interface information.You can see that Apifox uses the visual interface to edit the page to fill in, and it can generate interface information without learning any grammar. It is quick to get started and the learning cost is relatively low.

The effect obtained after saving is as follows. A project can be divided into multiple modules, and the interfaces of different modules can be saved in different folders.

Interface document read-only status

Step 2: Click to share online on the left to generate an interface document

Apifox supports one-click export of interface documents, supports sharing only part of interface documents, set expiration time, set password

Step 3: Real-time update of interface documents

Once the interface document is changed, the data will be synchronized to all members participating in the project in real time, and the shared interface document will be updated at the same time.

Second, the online interface documentation provides online debugging, mocking, code generation and other functional assistance

Partners receive the interface document link and can debug, mock, and generate code online at the online interface document

A. The interface documentation page supports online debugging

The shared interface documentation page supports simple basic debugging functions. If you want more powerful debugging assistance, you can use the Apifox client.

The debugging function of the client side visually encapsulates the functions of extracting variables, asserting, connecting to the database, etc. without writing scripts. If there are complex debugging requirements, the script debugging function is still supported

B. Support to generate code

There are quite a lot of code types supported, including various languages ​​and frameworks commonly used in the front and back ends. There are more than 130 kinds in total. The front-end code generated by javascript, swift, java, etc. can be used.

It not only supports the generation of interface request code, but also supports the generation of data model code. The code of the entire project can be generated on demand, and then adjusted by yourself, so that the amount of code that needs to be written is greatly reduced.

c.Provide mock environment

The interface request can also be simulated when the interface is not online, and highly realistic business data can be constructed for the front-end test page, the back-end and the test to debug and test the interface