In Documents, Sanplex provides API Space, where you can create API documentation under a specific project or product, and view the corresponding API libraries and API documents. In API Space, you can also manage API libraries and documents, data structures, versioning, and API publishing.

Sanplex provides an API Space home page where you can browse Standalone APIs, Product APIs, and Project APIs. After entering a library, product, or project, you can view the library’s data structures, API versions, folders, and documents.

Next, we will explain how to use API Space in detail.

1. Assign Permissions

1.1 Browse Permissions for API Space

Go to Admin > User Management > Permissions > API Management > Browse Documents and assign the required permissions. Permission assignment can be configured flexibly based on actual business needs.

All API-related permissions can be maintained here.

图1

1.2 Operation Permissions for API Space

Go to Admin > User Management > Permissions > API Management > Create and Maintain APIs and assign the required permissions. Permission assignment can be configured flexibly based on actual business needs.

All API-related permissions can be maintained here.

图2

2. Use the API Space Home Page

2.1 View the Home Page

Click API Space in the secondary navigation to open the API Space home page. By default, Standalone APIs is selected. Switch to Product APIs or Project APIs to view API libraries under a product or project.

图3

2.2 View Libraries and Documents

On the home page, click a library, product, or project to view the documents under it.

图4

3. Manage API Libraries (From the API Library Module)

3.1 Create an API Library

In API Libraries > Documents, click Create in the upper-right corner to open the API library creation page.

图5

On the creation page, you can configure the Base URL and the API library’s access control.

图6

After the API library is created, you can find it from the API library dropdown in the upper-left corner.

Once created, you can manage the library’s folders, versioning, and perform edit and delete operations.

3.2 Manage API Library Folders

Click the More icon in the upper-right of the folder area and select Manage Folders.

图7

Add folders as needed and click Save.

图8

When you reopen Manage Folders, you can reorder, edit, delete, and add subfolders.

图9

3.3 Edit and Delete an API Library

Click the More icon again and choose Edit API Library or Delete API Library.

Edit API library page:

图10

Delete confirmation page:

图11

4. Manage API Libraries (From Documents > API Space)

4.1 Create an API Library

Go to Documents > API Space and click Create Library to create an API library.

图12

In the creation dialog, you can configure the Base URL and access control. Sanplex supports creating:

• a Standalone API Library,
• a Product API Library,
• a Project API Library.

If you select Private, you can configure an allowlist of users.

图13

After the API library is created, you can find it from the API library dropdown in the upper-left corner.

Once created, you can manage the library’s folders, versioning, and perform edit and delete operations.

4.2 View API Libraries or Documents Under a Product/Project

Select a product or project to view the API libraries and documents under it.

图14

4.3 Manage API Library Folders

Hover over an API library and click More (on the right) to add folders, edit the library, or delete the library.

图15

Hover over a folder/document under an API library and click More to add a sibling folder, add a subfolder, edit the folder, or delete the folder.

图16

• Edit API Library / Edit Folder: Use Edit API Library or Edit Folder in the dropdown.

  图17

• Delete API Library / Delete Folder: Use Delete API Library or Delete Folder. A confirmation dialog will appear.

  图18
  图19

5. Manage Libraries

5.1 Create a Library

On the API Space home page:

• Under the Standalone APIs tab, click Create Library to create a standalone API library.
• Under the Product APIs or Project APIs tab, click Create Library to create an API library under a product or project.

图20

You can also click Create on the document list page to create a library.

图21

In the creation dialog, select the API library type and create the library under the corresponding product/project.

Note: Library access control is Public by default. You can choose the default permission option or set it to Private. Private libraries support configuring an allowlist of users.

图22

5.2 View Libraries

On the home page, you can view the number of documents in standalone API libraries. After switching to Product APIs or Project APIs, you can view products/projects under the corresponding portfolio/project group.

图23

After entering a library, use the breadcrumb/path navigation in the upper-left corner to switch between Standalone API Libraries, Product API Libraries, and Project API Libraries.

图24

6. Manage Folders

6.1 Create a Folder

When a library contains no folders or documents, the left folder navigation is empty. Click Add Folder to create a new folder.

图25

When a library already contains documents, click Add Folder from the settings button at the bottom to create a new folder.

图26

When a folder already exists, click More on the right side of the folder to add a sibling folder or a subfolder.

图27

6.2 Maintain Folders

Click More on the right side of a folder to edit or delete it.

图28

When editing a folder, you can change its library and its parent folder.

图29

7. Manage APIs

After organizing the folders in an API library, you can start adding API documents.

7.1 Create an API

Go to Documents > API Space and click Create API to create an API document.

If the API library has no API documents yet, you can also click Create API directly on the page.

图30

On the Create API page, complete the following fields:

• API Library: auto-filled and cannot be changed by default
• Folder: select a folder under the API library from the dropdown
• Request: supports HTTP/HTTPS/WS/WSS; methods GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD
• Request Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Development Status: Completed, In Progress, Hidden
• Owner: person responsible for the API
• Headers: request header fields
• Parameters: request parameter fields

图31

Request Body: supports four types—FormData, JSON, Array, Object. After selecting a type, define fields (field name, data type, required or not, description). You can add subfields and add/delete fields and subfields.

Request Example: generate or write a request example based on the request body definition.

图32

Response: define response fields (field name, data type, required or not, description) and manage subfields.

图33

Response Example: write a response example based on the response definition.

Description: a brief introduction to the API.

图34

After completing the API information, click Save. The API will appear in the API list, where you can view its development status and request path.

图35

7.2 Edit an API

In the API details page, click Edit in the upper-right corner to open the edit page.

图36

On the edit page, note that you cannot change the API Library the API belongs to.

图37

7.3 Full Screen and Delete

Click Full Screen to view the API document in full-screen mode.

图38

Click Delete to remove the API. A confirmation step is required.

图39

8. Publish APIs

Click Publish APIs to open the publishing version creation page and publish APIs.

图40

Create a published API version:

图41

After publishing, you can switch versions to view API documents.

图42

9. Version Management

Click Version Management to manage API document versions, view published versions, and delete versions that are no longer needed.

图43

图44

10. Manage Data Structures

Click Data Structures to open the data structure list.

图45

On the list page, click Create Data Structure.

图46

On the creation page, enter the data structure’s name, type, fields, and description.

图47

Created data structures appear in the list and can be viewed, edited, or deleted.

图48

11. Export Documents

Click Export in the upper-right corner. Select the export scope:

• API documents in the list, or
• all API documents not linked to a product or project.

Export format is Word, encoding is UTF-8, and the system exports content as a single merged document.

图49

图50