Linking an Oracle Apiary Specification

You can link an Oracle Apiary specification to an API. Apiary specifications can contain documentation and a console for making calls to the API.

When you connect to Oracle Apiary, it checks whether documentation exists for the API. If it does not, the Use As API Documentation option in the dialog is selected automatically so that the Apiary specification is used as documentation for the API. If documentation already exists for the API, the option is not selected. If you then select it manually, you are warned that the existing documentation will be deleted.

Topics

• Linking an Oracle Apiary Specification to an API

Linking an Oracle Apiary Specification to an API

Use this procedure to connect an Oracle Apiary Specification to an API.

To add an Oracle Apiary Specification to an API:

1. On the APIs List page, select an API.
2. Click the Apiary button.
   The Apiary Documentation dialog appears, allowing you to browse Specifications on Oracle Apiary.
3. Select an API Project and then click Connect.
4. Click Save.
   

If you have previously published the API, you must republish it to see the Apiary specification.