Launch Your First API

This tutorial describes launching and validating a simple API on API7 Gateway. You will complete the following steps:

1. Create a Published Service with a Route and an Upstream that points to httpbin upstream.
2. Validate the created API by sending a request.

Prerequisites

1. Install API7 Enterprise.
2. Have at least one gateway instance in your gateway group.

Start a Sample Upstream Service

If you are running API7 on Kubernetes, you will be deploying an httpbin application to your cluster in this section as the sample upstream service. Otherwise, skip to the next section where you will be using the hosted httpbin application as the upstream.

Start a sample httpbin application:

kubectl run httpbin --image kennethreitz/httpbin --port 80

You should see a pod/httpbin created response.

Expose the application's port 80 through a service:

kubectl expose pod httpbin --port 80

You should see a service/httpbin exposed response.

Create Service and Route

Dashboard

Create a Service

1. Select Published Services under your gateway group from the side navigation bar and then click Add Service.
2. Select Add Manually.
3. From the Add Service dialog box, do the following:
   • In the Name field, enter httpbin.
   • In the Service Type field, choose HTTP (Layer 7 Proxy).
   • In the Upstream Scheme field, choose HTTP.
   • In the How to find the upstream field, choose Use Nodes.
   • Click Add Node.
   • From the Add Node dialog box, do the following:
     • In the Host field, enter httpbin.org.
     • In the Port field, enter 80.
     • In the Weight field, enter 100.
4. Click Add. This will create a new service in the 'No Version' state.

Create a Route

1. Click the service that you just created in the previous step, and then click Add Route.
2. From the Add Route dialog box, do the following:
   • In the Name field, enter get-ip.
   • In the Path field, enter /ip.
   • In the Methods field, choose GET.
   • Click Add.

Below is an interactive demo that provides a hands-on introduction to creating no-version services. You will better understand how to use it in API7 Enterprise by clicking and following the steps.

ADC

Create the following configuration file:

adc.yaml

services:
  - name: httpbin
    upstream:
      name: default
      scheme: http
      nodes:
        - host: httpbin.org
          port: 80
          weight: 100
    routes:
      - uris:
          - /ip
        name: get-ip
        methods:
          - GET

Synchronize the configuration to API7 Enterprise:

adc sync -f adc.yaml

Ingress Controller

Create a configuration file containing the API7 Ingress Controller custom resource of a route:

apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
  name: get-ip
  namespace: api7
spec:
  http:
    - name: get-ip
      match:
        paths:
          - /ip
      backends:
        - serviceName: httpbin
          servicePort: 80

Apply the configuration to your cluster:

kubectl apply -f httpbin-route.yaml

You should see a response of the following:

apisixroute.apisix.apache.org/httpbin-route created

Validate the API

Dashboard

Send a request to the route:

curl "http://127.0.0.1:9080/ip"

You should see the following response:

{
  "origin": "127.0.0.1"
}

ADC

Send a request to the route:

curl "http://127.0.0.1:9080/ip"

You should see the following response:

{
  "origin": "127.0.0.1"
}

Ingress Controller

In the dashboard, you should see a service called api7_httpbin_80 under the Published Services.

First, expose the service port to your local machine by port forwarding:

kubectl port-forward svc/api7-ee-3-gateway-gateway 9080:80 &

The command above runs in the background and maps port 80 of the api7-ee-3-gateway-gateway service to port 9080 on the local machine.

Send a request to the route:

curl "http://127.0.0.1:9080/ip"

You should see a response similar to the following:

{
  "origin": "127.0.0.1"
}

And that’s it. You have your first API running now.

Add APIs by Importing OpenAPI

You can also add APIs by importing an OpenAPI 3.0 specification.

Create a Service

1. Select Published Services under your gateway group from the side navigation bar and then click Add Service.
2. Select Import OpenAPI.
3. From the Add Service dialog box, do the following:
   • In the OpenAPI 3.0 Specification field, upload the httpbin.yaml file.
   • In the Upstream Scheme and Service Type fields, keep the default settings HTTP.
   • In the How to find the upstream field, keep the default setting Use Nodes.
   • Click Add Node.
   • From the Add Node dialog box, do the following:
     • In the Host field, enter httpbin.org.
     • In the Port field, enter 80.
     • In the Weight field, enter 100.
   • Click Next.
4. Click Add. This will create a new service in the 'No Version' state. The basic information and labels are imported, and all paths in the OpenAPI file are transformed to routes in the service.

Below is an interactive demo that provides a hands-on introduction to adding services by importing OpenAPI. You will better understand how to use it in API7 Enterprise by clicking and following the steps.

Additional Resources

• Getting Started
  • Publish Service Version
• Best Practices
  • API Version Control