Search¶
The Developer Portal provides several useful features to build and nurture an active community of users for your APIs. This is required to advertise APIs, learn user requirements, and market trends.
Use the search facility¶
You can search for APIs in the API Publisher or Developer Portal in the following ways:
| Clause | Syntax |
|---|---|
| Full text search | As this is the default option, simply enter any attribute value of the API and search. For example, PizzaShackAPI will search for PizzaShackAPI in API name, context, version, documents, etc. |
| By the API's name | name:xxxx . For example, name:PizzaShackAPI Name is the API name. |
| By the API provider | provider:xxxx . For example, provider:admin Provider is the user who created the API. |
| By the API version | version:xxxx . For example, version:1.0.0 A version is given to an API at the time it is created. |
| By the context | context:xxxx. For example, context:/phoneverify Context is the URL context of the API that is specified as /<context_name> at the time the API is created. |
| By the API's status | status:xxxx . For example, status:PUBLISHED A state is any stage of an API's lifecycle. The default lifecycle stages include created, prototyped, published, deprecated, retired and blocked. |
| By description | description:xxxx A description can be given to an API at the time it is created or later. There can be APIs without descriptions as this parameter is optional. |
| By the subcontext | subcontext:xxxx . For example, subcontext:/checkphonenumber. A subcontext is the URL pattern of any resource of the API. API resources are created at the time the API is created or later when it is modified. For example, if you create a resource by the name |
| By the content of the API documentation | doc:xxxx You can create API documentation in-line (using the API Publisher UI itself), by uploading a file or referring to an external URL. This search enables you to give a sentence or word phrase that is inside the in-line documentation and find the API that the documentation is added for. |
| By tag | tag:xxxx . For example, tag:pizza A tag can be given to an API at the time it is created or later. There can be APIs without tags as this parameter is optional. |
| By microgateway label | label:xxxx . For example, label:marketing A label is used to group APIs based on the Microgateway distribution. It can be given to an API at the time it is created or later. There can be APIs without labels as this parameter is optional. |
| By a custom property | property_name:property_value A property can be defined to an API at the time it is created or later. There can be APIs without properties as this parameter is optional. |
| By API category | api-category:xxxx . For example, api-category:test An API category can be used to group APIs based on any criteria. API categories can be defined from the Admin Portal and can be assigned to an API from the Design Configurations section of the Publisher Portal. |