Expose your Services with Kong Gateway

1. On the Workspaces tab in Kong Manager, scroll to the Workspace section and click the default workspace.

   This example uses the default workspace, but you can also create a new workspace, or use an existing workspace.

2. Scroll down to Services and click Add a Service.

3. In the Create Service dialog, enter the name example_service and the URL http://httpbin.org.

4. Click Create.

The service is created, and the page automatically redirects back to the example_service overview page.

curl -i -X POST http://localhost:8001/services \
  --data name=example_service \
  --data url='http://httpbin.org'

http POST :8001/services \
  name=example_service \
  url='http://httpbin.org'

If the service is created successfully, you’ll get a 201 success message.

Verify the service’s endpoint:

curl -i http://localhost:8001/services/example_service

http :8001/services/example_service

1. In the kong.yaml file you exported in Prepare to Administer Kong Gateway, define a Service with the name example_service and the URL http://httpbin.org:

    _format_version: "1.1"
    services:
    - host: httpbin.org
      name: example_service
      port: 80
      protocol: http
   

2. Save the file. From your terminal, sync the configuration to update your gateway instance:

    deck sync
   

   The message should show that you’re creating a service:

    creating service example_service
    Summary:
    Created: 1
    Updated: 0
    Deleted: 0
   

1. From the example_service overview page, scroll down to the Routes section and click Add Route.

   The Create Route dialog displays with the Service field auto-populated with the Service name and ID number. This field is required.

   Note: If the Service field is not automatically populated, click Services in the left navigation pane. Find your Service, click the clipboard icon next to the id field, then go back to the Create Route page and paste it into the Service field.

2. Enter a name for the Route, and at least one of the following fields: Host, Methods, or Paths. For this example, use the following:
   1. For Name, enter mocking.
   2. For Path(s), click Add Path and enter /mock.
3. Click Create.

The Route is created and you are automatically redirected back to the example_service overview page. The new Route appears under the Routes section.

Define a Route (/mock) for the Service (example_service) with a specific path that clients need to request. Note at least one of the hosts, paths, or methods must be set for the Route to be matched to the service.

curl -i -X POST http://localhost:8001/services/example_service/routes \
  --data 'paths[]=/mock' \
  --data name=mocking

http :8001/services/example_service/routes \
  paths:='["/mock"]' \
  name=mocking

A 201 message indicates the Route was created successfully.

1. Paste the following into the kong.yaml file, under the entry for example_service:

    routes:
    - name: mocking
      paths:
      - /mock
      strip_path: true
   

   Your file should now look like this:

    _format_version: "1.1"
    services:
    - host: httpbin.org
      name: example_service
      port: 80
      protocol: http
      routes:
      - name: mocking
        paths:
        - /mock
        strip_path: true
   

2. Sync the configuration:

    deck sync
   

3. (Optional) You can update your local file with the new configuration:

   Be careful! Any subsequent deck dump will overwrite the existing kong.yaml file. Create backups as needed.

    $ deck dump
   

   Alternatively, you will also see this configuration in the diff that decK shows when you’re syncing a change to the configuration.

   You’ll notice that both the Service and Route now have parameters that you did not explicitly set. These are default parameters that every Service and Route are created with:

    services:
    - connect_timeout: 60000
      host: httpbin.org
      name: example_service
      port: 80
      protocol: http
      read_timeout: 60000
      retries: 5
      write_timeout: 60000
      routes:
      - name: mocking
        paths:
        - /mock
        path_handling: v0
        preserve_host: false
        protocols:
        - http
        - https
        regex_priority: 0
        strip_path: true
        https_redirect_status_code: 426
   

   You can do this after any deck sync to see Kong Gateway’s most recent configuration.

   The rest of this guide continues using the simplified version of the configuration file without performing a deck dump for every step, to keep it easy to follow.

By default, Kong Gateway handles proxy requests on port :8000.

From a web browser, enter http://localhost:8000/mock.

Using the Admin API, issue the following:

curl -i -X GET http://localhost:8000/mock/anything

http :8000/mock/anything