Plugin Template

Create Plugin Template

To use a plugin in a route/API, you need to configure one or more plugins in a plugin template and then reference that plugin template. Plugins cannot be used directly without a plugin template. This avoids configuring plugins repeatedly in multiple routes/APIs.

• Consumers can configure one or more plugins based on them, no need to use plugin templates.
• The same plugin can be used in multiple plugin templates, but each plugin can only be used once in the same plugin template.

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 click on Plugin Template .
8. Click on Create button.
9. Select the plugin(s) you want to enable and click the corresponding Enable button.
10. In Plugin Editor , toggle the Enabled switch.
11. In Raw Data Editor , edit the plugin parameters (optional, some plugins do not require any configuration to be used).
12. Click on Submit button.
13. You can enable multiple plugins as needed.
14. After all plugins are enabled, click on Submit button.

Configure Plugin Template

Edit the plugins and their parameters enabled in the plugin template.

• If a plugin template that is already used by a route/API is edited, the change will take effect dynamically and affect all associated route/API business logic.

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 click on Plugin Template .
8. Click on Configure button of the corresponding plugin template.
9. Select the plugin(s) you want to enable and click the corresponding Enable button.
10. In Plugin Editor form, toggle the Enabled switch.
11. In Raw Data Editor , edit the plugin parameters (optional, some plugins do not require any configuration to be used).
12. Click on Submit button.
13. You can enable multiple plugins as needed by repeating Steps 9-12.
14. To disable a plugin that has already been enabled, click on the Update button for the corresponding plugin, then click on the Delete button in Plugin Editor or directly click on Disable button for the corresponding plugin.
15. After configuring all the plugins, click on the Submit button.

Delete Plugin Template

Stop using the plugin template.

• Deletion is irreversible, please proceed with caution.
• Plugin templates associated with routes/APIs cannot be deleted.

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 click on Plugin Template .
8. Click on Delete button of the corresponding plugin template.
9. Click on Confirm button.