API

Create API

Create a route and expose it as an external API.

• Each route/API must select an upstream and cannot be left empty.
• One upstream can be paired with multiple routes/APIs.
• An API that is not published online cannot be called.
• If the same plugin is configured in both the consumer and the route/API, the plugin configuration in the consumer takes precedence.

1. Log in to the API7 Enterprise dashboard.
2. If the upstream is not ready, refer to Create Upstream.
3. In the top navigation menu, click on Cluster Management .
4. In the left menu bar, click on Cluster List .
5. Click on View button of the specific cluster.
6. In the left menu bar, click on Workspaces .
7. Click on View button of the specific workspace.
8. In the left menu bar, click on API then List .
9. Click on Create button.
10. Fill in the form.
11. Click on Submit button.

Configure API

Edit the API properties.

• The Publish property does not support editing.
• It is not recommended to directly modify an API with the status "published."

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific API.
5. In the left menu bar, click on Workspaces .
6. Click on View button of the specific workspace.
7. In the left menu bar, click on API then List .
8. Click on Configure button of the specific API, or click on More menu then click on Configure Raw data .
9. Edit API properties.
10. Click on Submit button.

Delete API

API permanently offline and no longer in use.

• Deletion is unrecoverable, please proceed with caution.
• It is recommended to first take the API offline, confirm that there's no impact on the business, and then proceed with deletion.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. In the left menu bar, click on Workspaces .
6. Click on View button of the specific workspace.
7. In the left menu bar, click on API then List .
8. Click on More menu, then click on Delete .

Duplicate API

Quickly create a new API similar to an existing one to reduce the workload of repetitive configuration.

Copying an API does not immediately create a published API. It simply uses the configuration of the existing API as a pre-filled input.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. In the left menu bar, click on Workspaces .
6. Click on View button of the specific workspace.
7. In the left menu bar, click on API then List .
8. Click on More menu of the specific API, then click on Duplicate.
9. Edit the API properties in the form.
10. Click on Submit button.

API Offline

Temporarily disable an API, keeping its configure data but making it not callable.

Only APIs with the "published" status can be offline.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. In the left menu bar, click on Workspaces .
6. Click on View button of the specific workspace.
7. In the left menu bar, click on API then List .
8. Click on More menu of the specific API, then click on Offline.

Publish API

Publish the unpublished API.

Only APIs with the "unpublished" status can be published.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. In the left menu bar, click on Workspaces .
6. Click on View button of the specific workspace.
7. In the left menu bar, click on API then List .
8. Click on More menu of the specific API, then click on Publish .

Import OpenAPI

Quickly create multiple routes/APIs by importing OpenAPI files.

• An upstream will be automatically created with the Task Name as the upstream name, the target node as 0.0.0.0, the port as 80, and the weight as 1.
• After importing, configure the upstream to set the correct target node.
• Multiple routes/APIs imported in the same import task will use the same upstream created by default.
• The name of each route/API will be automatically set as "Import Task Name + Path" and can be modified through API configuration later.
• The hostname of the workspace will be automatically used as the hostname for the imported routes/APIs and can be modified through API configuration later.

1. Log in to the API7 Enterprise console.
2. Click on Cluster Management in the top navigation menu.
3. Click on Cluster List in the left-side menu.
4. Click on the View button for the corresponding cluster.
5. Click on Workspace in the left-side menu.
6. Click on the View button for the corresponding workspace.
7. Click on API - API List in the left-side menu.
8. Click on the Advanced button and select Import OpenAPI from the dropdown menu.
9. Fill in the form.
10. Click the Submit button.