Oracle Cloud Infrastructure Documentation

Create an API Specification

Learn how to create an API specification for a database API gateway configuration pool.

API specifications are supported only when the ORDS RESTful Service Definition Location is set to CLOUD. For more information about this option, see Creating a Database API Gateway Configuration.

    1. In the Database API Gateway Configurations list page, find the configuration that you want to work with. If you need help finding the list page or the configuration, see List Database API Gateway Configurations.

    2. Select the Pools tab.

    3. In the Database API Gateway Configuration Pool list page, select the pool that you want.

    4. Select the API Specs tab and click Create API spec.

    5. In the Create API spec page, enter the following settings:

      • Name: Enter a user-friendly name to help easily identify this resource.

      • API description file: Drop or select an API specification file.

    For more information about API specifications, see API Specifications in the Oracle REST Data Services Installation and Configuration Guide.

  • Use the oci dbtools-runtime database-api-gateway-config-pool-api-spec create command to create an API specification for a configuration pool. 

    oci dbtools-runtime database-api-gateway-config-pool-api-spec create default 
--database-api-gateway-config-id <config-ocid> --pool-key <pool-key> --display-name <api-spec-name> 
--content <api-spec-content>

    For a complete list of parameters and values for CLI commands, see the Command Line Interface (CLI).

  • Use the CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec API to create an API specification for a configuration pool.

    For information about using the API and signing requests, see REST API and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.