Create a custom connector and a connection

This page describes how to create an OpenAPI specification for a web service and then create a custom connector and a connection for this connector.

Before you create a custom connector, you must create an OpenAPI specification for the web service.

Create an OpenAPI specification for the web service

Custom connectors support OpenAPI 3.0. You can also manually create the specification. For information about the OpenAPI specifications, see OpenAPI specifications.

You can also autogenerate the OpenAPI 2.0 specification using gin swagger middleware. For information, see Gin Swagger. You must convert the OpenAPI 2.0 specification to OpenAPI v3.0 specification by using Swagger Converter.

{
  "openapi": "3.0.0",
  "info": {
    "title": "Go HTTPbin Proxy Service",
    "description": "A simple Go service that proxies requests to httpbin.org, adding custom headers.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://localhost:8080"
    }
  ],
  "paths": {
    "/getData": {
      "get": {
        "summary": "Fetch data from httpbin.org/get",
        "description": "Sends a GET request to httpbin.org/get, including any custom headers.",
        "responses": {
          "200": {
            "description": "Successful response from httpbin.org",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/postData/{id}": {
      "post": {
        "summary": "Post data to httpbin.org/post",
        "description": "Sends a POST request to httpbin.org/post with data, including any custom headers.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"   

                  },
                  "address": {
                    "type": "string"
                  },
                  "gender": {
                    "type": "string"   
                  }
                },
                "required": [
                  "name",
                  "address",
                  "gender"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response from httpbin.org",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request - Invalid request body"
          }
        }
      }
    }
  }
}

Create a custom connector and validate the service

You must create a custom connector and then validate the web service by using it in a connection in Application Integration.

Before you begin

Set up Private Service Connect (PSC) for this virtual machine and then create an endpoint attachment.

Create a custom connector

1. In the Console, go to the Integration Connectors > Custom connectors page, and then select or create a Google Cloud project.

   Go to the Custom connectors page

2. Click Create new to open the Create custom connector page.
3. In the Connector details section, specify the required fields, such as Connector name and Display name.Also, enter the use cases for the connector in the Description field.
4. Configure connector destination for backend access: Enable this option. This shows the additional configuration sections in the page.
5. Service account: Select a service account that has the required roles.
6. Logo: Upload an image to a Cloud Storage bucket to use it as the connector logo.
7. In the Connector Specification section, either enter the public URL of your Open API specification or upload your specification file to a Cloud Storage bucket.
8. In Connector Destination section, add the IP address of the endpoint attachment and the port on which service is running.
9. In Connector Authentication section, select No Authentication. Authentication types are not supported for Marketplace connectors.
10. In Backend Variables section, add the variables you want to take as input while creating the connection. These variables appear in the connection creation page and are sent on every API call made to the service. The values which will not change with APIs, such as third-party backend credentials must be added in this section.
11. Create the custom connector. Ensure that you have specified a logo and described the use cases for the custom connector.

Create a connection

After you create the custom connector, create the connection for this connector.

1. In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.

   Go to the Connections page

2. Click Create new to open the Create connection page.
3. Select the custom connector that you created.
4. Add values for the connection fields that you had defined.
5. Create the connection.

Validate the service

To validate the service, create a new integration.

1. In the Google Cloud console, go to the Application Integration page and then create an integration.
2. Add API trigger and the connector task.
3. Configure the connector task to use the connection created in the earlier step. Add Data Mapper if required.
4. Set up the connectorInputPayload for the connector as per the schema.
5. Run the integration to verify that the connection is working.

If the Integration runs successfully and returns expected response, the web service is validated.

What's next

• Learn how to create a startup script for the web service.