API Management
The API Management module is designed specifically for developers, enabling them to manage their APIs and associated documentation in a structured and secure workspace. It allows full control over editing API information and organizing documentation throughout the API lifecycle.
Create & Organize with My Workspace
Before managing APIs, developers need to create a dedicated workspace:
-
Navigate to Workplace > My Workspace and click + Create New Workspace.
-
Fill in the required fields such as Title and Description to define your workspace.
-
Once created, the workspace serves as a private environment to manage and maintain your API projects.
Currently, these features are available for developers within this workspace.
Edit APIs: Update endpoint information, such as request methods, parameters, response formats, and examples.
Manage Documentation: Upload, import, or directly edit API documentation to ensure accuracy and consistency.
Group and Categorize APIs: Organize APIs into logical sections for better access and navigation.
Access Control & Collaboration
To support collaborative development, it allows user to setup the permission for each workspace. Available permission settings are below:
-
Read-Only: User can view content and Run API but cannot make any edits.
-
Editor: User can add new API endpoint and update API info.
-
Admin: User can get full control same as the workspace owner.
Meanwhile, workspace can be shared with team members or shared to public, allowing for seamless collaboration and better API lifecycle management.
-
If you want to share the API to public, please confirm the desired API, then click Share > Share to API Hub > Confirm to complete the process.
-
If you want to share the API to Users/Groups, please navigate to Share > Share to Users/Groups first. Then choose the existed role groups or enter a specific user’s email address for shares. Multiple users or groups are available on one share, it also supports to setup permission for them individually.