Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Described in brief detail below are prominent community features of the API Manager:

Documentation

Capability to associate comprehensive documents with an API so that API consumers get a better understanding of its use in implementing their solutions. Shown below is how documentation of a published API is visible to consumers through the API Store.

Image RemovedImage Added

All documents have unique URLs to help better SEO support.

Image RemovedImage Added

For more information on various types of documents, how to add and maintain them, refer to section Adding API Documentation.

Rating and Commenting

Consumers can rate APIs per version and comment on them, which can be used as a guideline on its quality and usefulness by potential subscribers. Commenting and rating help create a community around a particular API. Comments appear sorted by the time it was entered, alongside the author's name. Commenting is similar to a forum for subscribers, who can discuss common issues/features pertaining to a given API version.

Shown below is how comments/rates of a published API is visible to subscribers through the API Store.

Image RemovedImage Added

Searching

Before subscribing to an API, potential users can search for an API. Although, currently search is only supported by API name, we will facilitate more search options in the next release.

Tagging

When adding an API through the API Publisher, providers can include meaningful tags to an API. Tags allow API providers to group/categorize APIs having similar attributes/behavior/domain. Once a tagged API gets published to the API Store, its tags will appear as clickable links to the API consumers, who can use them to quickly jump to the APIs they are interested in.

Shown below is how tags are visible to subscribers through the API Store.

Image RemovedImage Added

Excerpt
hiddentrue

Community aspect in WSO2 API Manager.

...