Skip to content

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.

Let's see what community features are available in the Developer Portal:

You can search for APIs in the API Publisher or Developer Portal in the following ways:

Clause Syntax
Unified 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 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 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.