Getting started

To create an API gateway:

1. In the management console, select the folder where you want to create an API gateway.

2. In the list of services, select API Gateway.

3. Click Create API gateway.

4. In the Name field, enter numbers.

5. (optional) In the Description field, enter a description.

6. In the Specification section, add a specification:

   openapi: "3.0.0"
   info:
     version: 1.0.0
     title: Test API
   paths:
     /hello:
       get:
         summary: Say hello
         operationId: hello
         parameters:
           - name: user
             in: query
             description: User name to appear in greetings
             required: false
             schema:
               type: string
               default: 'world'
         responses:
           '200':
             description: Greeting
             content:
               'text/plain':
                  schema:
                    type: "string"
         x-yc-apigateway-integration:
           type: dummy
           http_code: 200
           http_headers:
             'Content-Type': "text/plain"
           content:
             'text/plain': "Hello, {user}!\n"
   

7. Click Create.

8. Access the API gateway.

   1. In the window that opens, click on the created API gateway.

   2. Copy the Domain field value and create a link like: https://<domain>/hello?user=API. The resulting link should look like this:

      https://falrnjna8r5vj88ero6a.apigw.yandexcloud.net/hello?user=API
      

   3. Access the API gateway using one of the commands:

      curl https://falrnjna8r5vj88ero6a.apigw.yandexcloud.net/hello?user=API
      curl https://falrnjna8r5vj88ero6a.apigw.yandexcloud.net/hello
      

To create a function:

1. Create a function:
   1. In management console, select the folder where you want to create your function.
   2. Click Create resource.
   3. Choose Function.
   4. In the Name field, specify list.
   5. Click Create.
   6. Make the function public.
2. Create the function version:

   1. In the window that opens, select the function you created.

   2. Under Latest version, click Create in editor.

   3. In the window that opens, in the Runtime environment field, choose nodejs12.

   4. In the Method field, select the code editor.

   5. Click Create file in the editor below.

      1. In the window that opens, enter the index.js file name.
      2. Click Create.

   6. Paste the following code in the index.js file:

      module.exports.handler = async (event) => {
          return {
              "statusCode": 200,
              "headers": {"content-type": "application/json"},
              "body": "[0, 1, 2]"
          };
      };
      

   7. In the Entry point field, enter index.handler.

   8. Click Create version.

To update an API gateway specification:

1. In the management console, select the folder to update the API gateway in.

2. In the window that opens, select the API gateway and click .

3. In the menu that opens, click Edit.

4. Under Specification, add an extended version of the specification.

   Added the /numbers method that uses the x-yc-apigateway-integration extension of the cloud-functions type to invoke a function by ID.

   To ensure that the API gateway works properly, in the function_id parameter, specify the ID of the function to invoke.

   To let the API gateway access a private function, in the parameter service_account_id specify a service account that has the rights to invoke the function.

   openapi: "3.0.0"
   info:
     version: 1.0.0
     title: Test API
   paths:
     /hello:
       get:
         summary: Say hello
         operationId: hello
         parameters:
           - name: user
             in: query
             description: User name to appear in greetings
             required: false
             schema:
               type: string
               default: 'world'
         responses:
           '200':
             description: Greeting
             content:
               'text/plain':
                  schema:
                    type: "string"
         x-yc-apigateway-integration:
           type: dummy
           http_code: 200
           http_headers:
             'Content-Type': "text/plain"
           content:
             'text/plain': "Hello, {user}!\n"
     /numbers:
       get:
         summary: List some numbers
         operationId: listNumbers
         responses:
           '200':
             description: Another example
             content:
               'application/json':
                  schema:
                    type: "array"
                    items:
                      type: "integer"
         x-yc-apigateway-integration:
           type: cloud_functions
           function_id: <function ID>
           service_account_id: <service account ID>