API Gateway QuickStart Guide

If suitable users and groups to create and access API Gateway and network resources don't exist already:

1. Sign in to the Console as a tenancy administrator.
2. Open the navigation menu  and select Identity & Security. Under Identity, select Domains.

3. Create a new group by selecting Groups and then Create Group.

   

4. Create a new user by selecting Users and then Create User.

   

5. Add a user to a group by selecting Groups, then the name of the group, and then Add User to Group.

   

See detailed instructions for more information.

If a suitable compartment in which to create API Gateway resources and network resources doesn't exist already:

1. Sign in to the Console as a tenancy administrator.
2. Open the navigation menu and select Identity & Security. Under Identity, select Compartments.

3. Select Create Compartment.

   

See detailed instructions for more information.

To ensure high availability, you can only create API gateways in regional subnets (not AD-specific subnets). If a suitable VCN with a public regional subnet in which to create network resources doesn't exist already:

See detailed instructions for more information.

If one or more API developers is not a tenancy administrator:

1. Sign in to the Console as a tenancy administrator.
2. Open the navigation menu and select Identity & Security. Under Identity, select Policies.

3. Create policies to give API developers access:

   
   1. Create a policy with one policy statement to enable API developers to access API Gateway-related resources. Select Create Policy, specify a name and description for the new policy, and select the compartment that will own API Gateway-related resources. Use the Policy Builder Manual Editor to enter the following policy statement, and then select Create:
      Copy

      Allow group <group-name> to manage api-gateway-family in compartment <compartment-name>

   2. Create a policy with one policy statement to enable API developers to access network resources. Select Create Policy, specify a name and description for the new policy, and select the compartment that owns the network resources to use with API Gateway. Use the Policy Builder Manual Editor to enter the following policy statement, and then select Create:
      Copy

      Allow group <group-name> to manage virtual-network-family in compartment <compartment-name>

   Note: The above policies are sufficient to enable you to create an API deployment with an HTTP back end, as suggested in this QuickStart Guide. You can enter additional policies (as described in the documentation) to enable API developers to create API deployments with OCI Functions functions as back ends, and to enable API gateways to authenticate with a cache server to retrieve cached response data.

See detailed instructions for more information.

1. Sign in to the Console as an API Gateway developer, open the navigation menu  and select Developer Services. Under API Management, select Gateways.
2. Select Create Gateway and specify:
   • a name for the new gateway, such as acme-api-gateway
   • the type of the new gateway as Public
   • the name of the compartment in which to create API Gateway resources
   • the name of the VCN to use with API Gateway
   • the name of the public regional subnet in the VCN
   
3. Select Create.

   When the new API gateway has been created, it is shown as Active in the list on the Gateways page.

See detailed instructions for more information.

1. On the Gateways page in the Console, select the name of the API gateway you created earlier.
2. Under Resources, select Deployments, and then select Create Deployment.

3. Select From Scratch and in the Basic Information section, specify:

   • a name for the new API deployment, such as acme-api-deployment
   • a path prefix to add to the path of every route contained in the API deployment, such as /v1
   • the compartment in which to create the new API deployment
   

4. Select Next and in the Route 1 section, specify:

   • a path, such as /hello
   • a method accepted by the back-end service, such as GET
   • the type of the back-end service, and associated details. For convenience, specify the type as HTTP and enter a public API as the back end's url (such as https://api.weather.gov).
   

5. Select Next to review the details you entered for the new API deployment, and select Create to create it.

   

   When the new API deployment has been created, it is shown as Active in the list of API deployments.

6. When the API deployment is active, go on to the next task.

See detailed instructions for more information.

1. In the list of API deployments, select Copy beside the endpoint of the new API deployment you just created to copy the endpoint.

2. Open a terminal window and call the API by entering:

   Command

   CopyTry It

   curl -k -X GET <deployment-endpoint>

   where <deployment-endpoint> is the endpoint that you copied in the previous step. For example, https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/v1/hello

Congratulations! You've just created your first API gateway and API deployment, and called your first API using the API Gateway service!

See detailed instructions for more information.

Now that you've created, deployed, and called an API function, learn how to:

• managing API gateways and API deployments (see Listing API Gateways, Updating an API Gateway, Deleting an API Gateway)
• limiting the number of requests (see Limiting the Number of Requests to API Gateway Back Ends)
• adding CORS support (see Adding CORS support to API Deployments)
• adding stock responses (see Adding Stock Responses as an API Gateway Back End)
• confirming API caller identity and permissions (see Adding Authentication and Authorization to API Deployments)

You're done!