Publish APIs by Service

After your APIs are designed, developed, and deployed, you can use API7 Enterprise to publish them.

Typically, APIs are published first in test and staging environments before publishing in production environments. API7 Enterprise manages this separation through Gateway Groups, where an API is a Service with a shared Upstream.

This tutorial guides you in publishing the httpbin API to a test environment on API7 Enterprise. You will learn how to:

1. Create a service manually and through an OpenAPI Specification file.
2. Publish services by configuring upstream nodes and by using service discovery mechanisms.

Prerequisites

1. Install API7 Enterprise and complete the Launch Your First API tutorial.
2. Rename the default gateway group to Test Group and configure the network. Test Group will be the API gateway for your test environment.
3. Have at least one Gateway Instance in the Test Group.

Add a Service with Routes

Add Manually

1. Select Services from the side navigation bar, then click Add Service.
2. Select Add Manually.
3. In the Name field, enter httpbin API.
4. Click Add.
5. Inside the service, click Add Route.
6. From the Add Route dialog box, do the following:
   1. In the Name field, enter getting-started-anything.
   2. In the Path field, enter /anything/*.
   3. In the Methods field, choose GET.
7. Click Add.

Import OpenAPI 3.0 Specification

API7 Enterprise supports OpenAPI v3.0 and above. First, define your API in a YAML/JSON file as shown below:

OpenAPI.yaml

openapi: 3.1.0
info:
  title: httpbin API
  description: "httpbin API for the API7 Enterprise Getting Started guides."
  version: 1.0.0
paths:
  "/anything/*":
    get:
      tags:
        - Anything
      summary: Returns anything that is passed into the request.
      operationId: getting-started-anything
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: string
tags:
  - name: Anything
    description: Return anything that is passed in on the request.

Then, use it in API7 Enterprise:

1. Select Services from the side navigation bar, then click Add Service.
2. Select Import OpenAPI.
3. Upload your YAML/JSON file and choose HTTP in the Upstream Scheme field.
4. Click Next.
5. Confirm the following information and then click Next:
   1. Name: the title field in OpenAPI Specification.
   2. Labels: the tag field in OpenAPI Specification.
   3. Description: the description field in OpenAPI Specification.
   4. Routes: the Paths field in OpenAPI Specification.
6. Click Add.

Publish the Service Using Upstream Nodes

Publish a Single Service

1. Select Services from the side navigation bar and then select httpbin API.
2. Click Publish Now.
3. Select Test Group and then click Next.
4. From the dialog box, do the following:
   • In the New Version field, enter 1.0.0.
   • In the How to find the upstream field, choose Use Nodes.
   • Click Add Node. From the dialog box, do the following:
     • In the Host and Port fields, enter your backend node address in the test environment. For this tutorial, use httpbin.org as the host and 80 as the port.
     • In the Weight field, use the default value 100.
     • Click Add.
5. Confirm the service information and then click Publish.

Publish Batch Services

1. Select Services from the side navigation bar and then click Batch Publish Services.
2. In the Gateway Group field, choose Test Group and then click Next.
3. Click Add Service. From the dialog box, do the following:
   • In the Service field, choose httpbin API.
   • In the New Version field, enter 1.0.0.
   • Click Add.
4. Confirm the service information and then click Next.
5. In the How to find the upstream field, choose Use Nodes.
6. Click Add Node. From the dialog box, do the following:
   • In the Host and Port fields, enter your backend node address in the test environment. For this tutorial, use httpbin.org as the host and 80 as the port.
   • In the Weight field, use the default value 100.
   • Click Add.
7. Confirm the service information and then click Publish.

Publish the Service Using Service Discovery

Instead of configuring the upstream directly, service discovery mechanisms like Consul, Eureka, Nacos or Kubernetes Service Discovery can be used to dynamically detect upstream nodes.

info

Once published, a service cannot directly switch between configured upstream nodes and service discovery. Instead, you have to configure this through a canary deployment.

Kubernetes

1. Select Gateway Groups from the side navigation bar, then choose Test Group.
2. Select Service Registries from the side navigation bar and then click Add Service Registry Connection.
3. From the Add Route dialog box, do the following:
   1. In the Name field, enter Registry for Test.
   2. In the Discovery Type field, choose Kubernetes.
   3. Fill in the API Server Address and Token Value field.
   4. Click Add.
4. Wait to make sure the status of the service registry is Healthy.
5. Select Services from the side navigation bar, then click Publish Now for the httpbin API service.
6. Choose the Test Group gateway group and then click Next.
7. From the Publish dialog box, do the following:
   1. In the New Version field, enter 1.0.0.
   2. In the How to find the upstream field, choose Use Service Discovery.
   3. In the Service Registry field, choose Registry for Test, then choose the Namespace and Service Name.
   4. Confirm the service information, then click Publish.

Nacos

1. Select Gateway Groups from the side navigation bar, then choose Test Group.
2. Select Service Registries from the side navigation bar and then click Add Service Registry Connection.
3. From the Add Route dialog box, do the following:
   1. In the Name field, enter Registry for Test.
   2. In the Discovery Type field, choose Nacos.
   3. In the Hosts field, fill in the host address and port.
   4. In the How to Get Token field, choose a way to get the token and configure related parameters.
   5. Click Add.
4. Wait to make sure the status of the service registry is Healthy.
5. Select Services from the side navigation bar, then click Publish Now for the httpbin API service.
6. Choose the Test Group gateway group and then click Next.
7. From the Publish dialog box, do the following:
   1. In the New Version field, enter 1.0.0.
   2. In the How to find the upstream field, choose Use Service Discovery.
   3. In the Service Registry field, choose Registry for Test, then choose the Namespace, Group and Service Name.
   4. Confirm the service information, then click Publish.

Use ADC to Publish the API

Alternatively, use ADC to configure API7 Enterprise declaratively instead of the dashboard. The complete configuration is below:

adc.yaml

services:
  - name: httpbin API
    upstream:
      name: default
      scheme: http
      nodes:
        - host: httpbin.org
          port: 80
          weight: 100
    routes:
      - uris:
          - /anything/*
        name: getting-started-anything
        description: Return anything that is passed in on the request.
        methods:
          - GET

Synchronize the configuration to API7 Enterprise:

adc sync -f adc.yaml

Validate the API

curl "http://127.0.0.1:9080/anything/publish"

You should see the following output:

{
  "args": {},
  "data": "",
  "files": {},
  "form": {},
  "headers": {
    "Accept": "*/*",
    "Host": "localhost",
    "User-Agent": "curl/7.88.1",
    "X-Amzn-Trace-Id": "Root=1-664cc6d6-10fe9f740ab1629e19cf85a2",
    "X-Forwarded-Host": "localhost"
  },
  "json": null,
  "method": "GET",
  "origin": "152.15.0.1, 116.212.249.196",
  "url": "http://localhost/anything/publish"
}