1. Automate the process to bulk upload and deploy APIs
  2. Learn About the Workflow for Creating and Deploying Bulk APIs in Oracle API Platform Cloud Service

Learn About the Workflow for Creating and Deploying Bulk APIs in Oracle API Platform Cloud Service

Your REST APIs represent a significant development investment, and when you have hundreds or thousands of APIs, publishing, monitoring, controlling and retiring them one at a time can be a time consuming task. You can use Oracle API Platform Cloud Service REST capabilities to automate the process of loading APIs to the platform.

Oracle API Platform Cloud Service lets you register and manage the lifecycle of multiple application programming interfaces (APIs) at once. In Oracle API Platform Cloud Service you can publish, monitor and retire APIs, control and manage API access, track resource consumption and error rates, and manage the consumers of those APIs.

If you have a significant number of back-end services that need to be published as a simple API, use the Oracle API Platform Cloud Service REST APIs to create utility scripts and automate processes, such as creating and deploying APIs in the platform.

Architecture

You can develop a Python utility script that uploads and deploys APIs to Oracle API Platform Cloud Service by using the Management Service REST API.

Description of upload-utility-bulk-api-platform-cloud-service.png follows
Description of the illustration upload-utility-bulk-api-platform-cloud-service.png

upload-utility-bulk-api-platform-cloud-service.zip

Use the following workflow to develop a Python utility:

  1. Create a Python configuration helper file (.py) where you configure the input of the utility program, define the REST endpoints, the connection details to the Oracle API Platform Cloud Service server, and the JSON template variables that are passed to the upload utility program.
  2. Create a CSV file that contains the information for the APIs. Each row represents one API. You can use the information of each row to create JavaScript objects in JSON notation for each request.
  3. You develop the main Python utility script that queries the user for their credentials to deploy multiple APIs one by one to API Platform Cloud Service.
  4. Run the main Python utility, .py script to trigger the whole process.

About Required Services, Components, and Roles

You need access to the following services, and tools installed to create and deploy APIs into Oracle API Platform Cloud Service:

  • Oracle API Platform Cloud Service

  • A subscription to Oracle Identity Cloud Service is required to use API Platform Cloud Service.
  • Python 2.7 or 3.x installed to develop, and execute the utility.

You need to have the following role to use the REST APIs from Oracle API Platform Cloud Service.

Service Name: Role Required to...
Oracle API Platform Cloud Service: API Manager role or membership in a group that has the API Manager role Use the REST API for the Management Service in Oracle API Platform Cloud Service

See Learn how to get Oracle Cloud services for Oracle Solutions to get the cloud services that you need.

Change Log

This log lists significant changes: