Adding Tags to an API
Pre-requisites:
You must have the Manage APIs functional privilege assigned to perform this task.
Tags are not automatically assigned to APIs, resources, methods, or operations. You can add one or more tags, and you can remove tags from an API, resource, method, or operation at any time.
You can define a set of consistent tags that meets your needs for each API, resource, method, or operation. Using a consistent set of tags makes it easier to manage the APIs, resources, methods, or operations. You can search the APIs, resources, methods, or operations based on the tags you add. To add an existing tag, you can use the typeahead search support that lists the existing tags, which match the character you type. You can restrict the number of existing tags that display, which match the typeahead character you provide, by configuring the extended setting
tagsTypeAheadSearchResultSize in the
Administration >
General >
Extended settings section. For details about configuring extended settings, see
Configuring Extended Settings.
When tagging an API, keep the following points in mind:
You can assign tags to the following API types and their components:
SOAP API. You can assign tags to the SOAP API and to its operations.
REST API. You can assign tags to the REST API, and to its resources and methods.
REST-enabled SOAP API. You can assign tags to the REST-enabled SOAP API. Also, you can assign tags to the REST resources and methods which correspond to the transformed SOAP operations.
OData API. You can assign tags to the OData API only.
WebSocket API. You can assign tags to the WebSocket API only.
When you delete an API, resource, method, or operation in
API Gateway, any tags that were assigned to that API, resource, method, or operation are not deleted.
To tag an API
1. Click APIs in the title navigation bar.
A list of all registered APIs appears.
2. Select the required API.
The API details page appears.
3. Click Edit.
4. To add tags to an API, in the Basic information section, do one of the following:
To add an existing tag, select an existing tag from the drop-down list and click
.
Alternatively, you can search an existing tag by typing characters in the
Tags field that displays a list of existing tags that contain the character, select the required tag, and click
.
To add a new tag, type the new tag and click
.
The tag is listed below the Tags field. To delete a tag, click the x icon.
5. To add tags to resources or methods of a REST API, in the Resources and methods section, locate the required resource or method and do one of the following:
To add an existing tag, select an existing tag from the drop-down list and click
.
Alternatively, you can search an existing tag by typing characters in the
Tags field that displays a list of existing tags that contain the character, select the required tag, and click
.
To add a new tag, type the new tag and click
.
The tag is listed below the Tags field. To delete a tag, click the x icon.
6. To add tags to an operation of a SOAP API, in the Operations section, locate the required operation and do one of the following:
To add an existing tag, select an existing tag from the drop-down list and click
.
Alternatively, you can search an existing tag by typing characters in the
Tags field that displays a list of existing tags that contain the character, select the required tag, and click
.
To add a new tag, type the new tag and click
.
The tag is listed below the Tags field. To delete a tag, click the x icon.
7. Click Save.