API Library

ZenTao Open Source Version 15.7, the API library document function has been added in the document view.API documents, data structures can be managed here.
Next, we will introduce the use of the API library in detail.

First， Allocating authority

First, you need to assign the relevant operation permissions of the API library.
Go to the Admin--member--privilage, and assign the permissions of the following screenshots.

Permission assignment can be flexibly assigned according to actual work needs.

Second, maintain the API library

1. Create an API library
Click the Create button in the upper right corner of the API Library - Documentation page to enter the API library creation page.

The API library creation page can set the request base path and the access control of the API library.

After the API library is created successfully, you can view it in the API library drop-down component in the upper left corner.
After the API library is created successfully, we can perform directory, version management, editing, and deletion operations on the API library.

2. Maintain the API library directory
Click the maintenance directory of the more icon in the upper right corner of the directory to enter the maintenance directory of the maintenance API library.

After adding the directory of the API library as needed, click Save.

Enter the maintenance directory page again, you can sort the directory, edit and delete, and add sub-directories.

3. Edit and delete API library

Also click the More icon in the upper right corner of the directory, and click the Edit API Library and Delete API Library buttons in the drop-down to operate.

Edit API library page:

Third，Maintenance API

After maintaining the directory of the API library, we can add the API library document.

1. Create an interface

Click the Create API button in the middle of the page, or the Create button in the upper right corner, to enter the API document creation page.

To create an API page, you need to fill in a little more content.

API Library: You can select the interface library you belong to in the drop-down list
Directory: The directory of the interface library to which it belongs, or you can select it from the drop-down list
Request Path: currently supports HTTP and HTTPS, GET, POST, PUT, DELETE, PACTH, OPTIONS, HEAD
Type: application/json , application/x-www-form-urluncoded , multipart/form-data
Status: development completed, in development, not displayed
Owner: The person responsible for the interface
Request header: The request header field of the interface
Parameters: The request parameter field of the interface

Request Body: There are 4 types: FormData, JSON, Array, Object
After selecting the type, you can fill in the field name, field type, whether it is required, and description according to the type.

And add subfields to fields, add and delete fields and subfields.

Request example: According to the request body, give a request example.

Request response: fill in the response fields of the API, field type, whether it is required, description, adding subfields, etc.

Response example: According to the request response field of the API, write a response example.
Description: A brief introduction to the API.

After filling in the information, click Save to view the successfully added API in the list.
You can view the status of the API and request the path.

2. Edit interface

Click the name of the API document in the interface list to enter the interface details page.
Click the Edit button in the upper right corner to enter the API editing page.

Edit API page:
It should be noted that editing an API cannot change the API library it belongs to.

3. Publish

Publishing an API enables version management of API documents.
Click the publish button in the upper right corner to enter the version creation page of the publish.

After the API is published successfully, you can switch versions to view the API documentation.

5. Version management
After the API is published, you can also use the More button in the upper right corner of the directory to perform version management.
Here you can view published versions and delete unwanted versions.

Fourth, maintain the data structure

Next we introduce the data structure function.

Click the Create Data Structure button in the upper right corner of the page to enter the Add Data Structure page.