Overview#

API Portal is the Best Practice for finding an audience for your API

API Portal allows developers to discover your API so they can begin evaluating it for their use case.

Developers Tools, Documentation and Examples#

API Portal should include all of the tools developers need to learn about and begin using your API.

Developers reviewing your API will only invest a few minutes before deciding whether or not to continue; having information available in a clear and easy-to-consume format will encourage them to stick around rather than go elsewhere.

Developers will quickly scan your documentation to get an overview of its functionality and then zero in on what it will take for them to get up and running on the API.

From there, they’ll quickly want to see some examples and ideally, start interacting with the API.

Developers are far more likely to use an API that includes interactive documentation that allows them to interact with the API over static pages that only allow them to read about it.

The API Portal delivered in MuleSoft’s Anypoint Platform for APIs is a good example of the value-added features that make it easy for application developers to engage with and start using an API.

API Portal should include interactive documentation that not only describes the endpoint but also the fields required to call that API and the data that is returned.

In addition, you can add code Examples to give developers a head start in building the code to access your API in the applications they build. Finally, the Console includes “try it” functionality that allows developers to interact with and test the API. During the design phase before the API has been implemented, a mocking service allows developers to test the API’s behavior and see the resulting body a call to that API would produce. Once the API is implemented, developers can test the live API.

More Information#

There might be more information for this subject on one of the following:

Add new attachment

Only authorized users are allowed to upload new attachments.
« This page (revision-1) was last changed on 10-Aug-2016 17:46 by jim