After creating your APIs, you must add metadata to and publish the API before it receives any traffic. This chapter describes curating and publishing WSDL-based SOAP and REST proxy services as APIs using the Oracle Service Bus Console, which is installed with API Manager.
The tasks described here are performed by users with the API Curator role.
Note:
API proxy services need to be created and activated before you begin the tasks in this chapter. See Creating Your APIs for more information.
The following topics are covered:
After creating a proxy service, you can add descriptive metadata that is displayed in an API detail page in the API Manager Portal.
API Consumers use this metadata to determine if an API is a good choice for their application and to test the API. Users with access to the Service Bus console can also evaluate this API using the metadata.
To edit the metadata of an API:
The status of an API determines whether it is hidden from or published to the API Manager Portal.
API status is set in the Status list in Publish Status region on the API tab, as shown in the following figure:
You can set the following status for an API:
Draft: Draft APIs are not published to the Oracle API Manager Portal and all requests to them are blocked. This is the default option.
Private: Private APIs are available for users with Developer privileges in Oracle Service Bus. Private APIs are not visible in the API Manager Portal and are unavailable to users with the API Consumer role. Making an API Private describes making an API private.
Published: Published APIs are published to consumers on the Oracle API Manager Portal. Publishing an API to the Oracle API Manager Portal describes publishing an API.
You can make an API private if you want it to be available for users with Developer privileges in Service Bus. APIs marked private are not visible in the API Manager Portal and are unavailable to users with the API consumer role.
To make an API private:
Before making an API available to consumers through the API Manager Portal, you should decide whether it should be managed or unmanaged. You then change the status to Published to publish the API.
Tip:
Make sure that you have added metadata to the API, as described inEditing the Metadata of an API, before publishing it to the API Manager Portal.
Before publishing an API, you decide whether an API should be published as managed or unmanaged:
Managed APIs can only be invoked by passing the application's entitlement key as a header at runtime. Users must subscribe to an API to receive this key. Users attempting to invoke managed APIs without using the key will receive an error message.
Unmanaged APIs are not controlled at runtime and can be accessed without passing an entitlement key. Users can invoke these APIs without subscribing to them.
You select the Managed check box when you publish an API to make it managed, as described in Changing the Status of an API to Published. If you later decide that the API should not be published, deselect the Managed check box.
Note:
If you decide to make a previously managed API unmanaged, user requests to the API that include an application's entitlement key, which is required for managed but not unmanaged APIs, will ignore the X-API-KEY
attribute in the header. The request is processed normally.
If you have published an API, but later decide that it should not be visible on the API Manager Portal and all requests to the API should be blocked, then you can set its status back to draft.
Note:
Deleting a proxy service from the Service Bus Console will also remove it from the API Manager Portal.
To change the status of an API to draft:
Deprecated APIs will remain published to the API Manager Portal. Users can view the details of, but cannot subscribe to, deprecated APIs.
You can provide details about why the API was deprecated, such as which API supersedes the deprecated version.
Note:
Users who have subscribed to an API before it is deprecated will still be subscribed to it. Requests to the API are processed normally.
To deprecate an API:
Next steps include discovering, testing, and using APIs.
See Using the Oracle API Manager Portal for more information.