We can create an API document template and use the API document template to add API documents to achieve the purpose of improving the efficiency of API document creation and standardizing the format of API documents.
This function is a paid version function and needs to be upgraded to the enterprise version to use it.
Create an API documentation template
Function entry : API management application / select a project / public resource menu / API document template secondary menu / click "+ Add API template"
The editable content of the API document template is consistent with the editing content of the API document, and the operation experience is synchronized. For specific editing operations, please refer to "Editing API Documents" .
-
API Documentation Template Hierarchy
-
API document templates are public resources, and all public resources have hierarchical ownership, which is divided into application module level and project level. Public resources at the application module level can be used by all projects, and public resources at the project level can only be used by the current project.
-
The API document template at the application module level can be created and edited in the "API Document Template" menu of the public resource secondary menu of the API management application interface.
use template
Function entry : API management application / API document menu / click the drop-down button next to the "+ API" button / select "Add API from template"
After selecting a template, the content of the API template is automatically imported into the newly created API document. It should be noted that templates are not associated with newly created API documents. That is, subsequent template content changes will not affect the content of the API document.
