1. Integrating and Extending Oracle Content Management
  2. Developing Oracle Content Management Integrations
  3. Oracle Content Management REST APIs
  4. Upload a REST API Swagger File into Mobile Cloud Service

Upload a REST API Swagger File into Mobile Cloud Service

In Oracle Mobile Cloud Service (MCS), you can create a REST connector API to connect to the REST API for Documents.

If you provide a Swagger descriptor URL, the REST Connector API wizard can examine the descriptive metadata and obtain resources and fields from it.

Only Swagger metadata in JSON format is currently supported.

A REST connector API is a configuration for communicating with a specific external service to send and receive data. REST connector APIs give you a standard way to connect a mobile app to existing REST services and at the same time benefit from the Oracle Mobile Cloud Service's built-in security, diagnostics, and analytics features.

The connector API communicates and passes information between the client and the server using the HTTPS protocol. The information passed can be in the form of XML or JSON (JavaScript Object Notation). REST doesn’t contain a messaging layer. It uses a set of rules to create a stateless service.

The REST Connector API wizard walks you through creating REST connector APIs, from specifying a remote service and setting security policies to testing your endpoints. Additionally, the wizard supports Swagger. When you provide a Swagger descriptor URL, the wizard introspects the endpoints available from that file. The available resources are identified and displayed. You simply select the resources of the external service.

Only standard internet access ports 80 and 443 are supported. Connection to a service can't be made using a custom port.

Use the REST Connector API wizard to quickly configure your connector API by providing a name and description, specifying timeout settings, adding rules, setting a security policy, and testing it.

Creating a connection to an existing REST service can be a simple two-step operation:

  1. Name your REST connector API.

  2. Provide the URL to the external service.

    In the REST Connector API wizard, on the page where the you would provide the URL to the Swagger file, there’s a link to the internal Oracle API catalog. You can get the Swagger URL from there and paste it in the field provided for the descriptor.

You have the option of applying rules to form specific requests or responses for the data that you want to access. In addition, you have the ability to configure client-side security policies for the service that you’re accessing and test and check the results of your connection.

As soon as it’s created, your REST connector API is listed on the Connectors page. When at least one REST connector API exists, you’ll be taken directly to the Connectors page when you click Connectors from the side menu. From the catalog, you can select the REST connector API and edit it, publish it, create a new version or update an existing version, deploy it if it has a Published state, or move it to the trash.

For more information, see "REST Connector APIs" in Developing Applications with Oracle Mobile Cloud, Enterprise.