Estimated reading time:
You are browsing documentation for an outdated version of Kong Kong Gateway. Go here
to browse the documentation for the latest version.
Hello World: Proxying your first API
Kong sits in front of any configured API, and it’s the main entry point of any HTTP request. For example, let’s configure Kong to support mockbin as an API:
$ curl -i -X POST \
--url http://127.0.0.1:8001/apis/ \
HTTP/1.1 201 Created
We used the
8001 port, which the RESTful Admin API of Kong listens on.
We can now make our first HTTP requests through Kong by using the
8000 port, which is the port that API consumers will use to consume any API behind Kong:
$ curl -i -X GET \
--url http://127.0.0.1:8000/ \
--header 'Host: api.mockbin.com'
HTTP/1.1 200 OK
Kong accepted the request and proxied it to the
target_url property we configured when adding the API,
http://mockbin.com, and sent us the response.
On a side note you will notice a little trick: we are requesting the API on
127.0.0.1 by manually setting the
Host header to match the
public_dns of the API. This will fool the system by making it believe the request has been made to
api.mockbin.com. In production you want to setup a DNS record that will reference the domain name to your Kong servers through a CNAME or A record, thus avoiding doing this trick. If Kong is sitting behind a load balancer, then the domain should target the load balancer.
Congratulations! The API has been successfully added to Kong and now we can start adding functionalities on top of it.