The Oracle API Gateway (OAG) plugin provides features to build and deploy Api Specification to various Oracle Cloud Infrastructure (OCI) tenancies.

Prerequisites

• Java 8 must be used on the endpoint

• API Specifications must be sourced from SCM

• OCI Requirements → https://docs.oracle.com/en-us/iaas/Content/APIGateway/Concepts/apigatewayprerequisites.htm

  • OCI Tenancy

  • Sufficient quota on API Gateway-related resources

  • Within the Tenancy must exist a compartment to own necessary network resources

  • The compartment that owns network resources must contain a VCN, a public or private regional subnet, and other resources

  • The VCN must have a set of DHCP options that includes an appropriate DNS resolver to map host names defined in an API deployment specification to IP addresses.

  • To create API gateways and deploy APIs on them, you must belong to one of the following:

    1. The tenancy's Administrators group.

    2. A group to which policies grant the appropriate permissions on network and API Gateway-related resources. See Create Policies to Control Access to Network and API Gateway-Related Resources.

Key Features

• API Specification files are sourced from Source Code Repository like Git, Subversion etc.

• API Specifications can be Swagger UI / Open API 3.x format or the native API Specification defined by Oracle.

  • Oracle Cloud Infrastructure API Specification Definition

• Build process validates API specification files.

• Oracle cloud infrastructure connection details stored in FlexDeploy.

• Package-based approach, customers can pick various API Specifications to deploy.

• Property replacement for API specification files.

• Link API resource and API Deployments and FlexDeploy executions together with defined tags.

• Setup reusable OCI cloud accounts to allow deployment to one or more tenancy and/or region.

Plugin Operations

• apiBuild

• apiDeploy

Object Type Reference

• API Specification

Cloud Account Properties