Designing an API

Use Apiary to design, document, and test your API.

Oracle Apiary provides you with the ability to design APIs using either API Blueprint or Swagger 2.0. From these description files, Oracle Apiary generates interactive documentation and a console for making calls to the APIs from the UI. Oracle Apiary also instantiates a mock service that you can use to interact with the examples provided in the specification file. API Managers can link APIs they have on Oracle Apiary to display interactive documentation, a test console, and mock service details on an API’s page in the Developer Portal.

Description of the illustration gj_apiary.jpg

To design an API in Apiary, follow these basic steps:

1. Create and name a new API Project in Apiary.

2. Add or edit the Swagger or API Blueprint code for your API.

3. View and edit documentation interactively in the editor.

4. Use the mock server to prototype your design and test it.