Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 3.53 KB

api-management.adoc

File metadata and controls

79 lines (58 loc) · 3.53 KB
Raw

Use API Management to take control of your microservices

APIcast (https://github.com/3scale/apicast) is an Open Source API Gateway whose main focus areas are high performance and extensibility. It is part of the Redhat 3scale API Management solution, and is used by hundreds of companies around the world to expose their APIs in a secure and controlled way.

Prerequistes

Install and enable SSO before using this module. SSO is used to issue the JWT tokens during the OpenID Connect (http://openid.net/connect/) over OAuth 2.0 standard code flow to enable the secure connection to the gateway.

Create a custom API Management build

$ git clone https://github.com/redhat-helloworld-msa/api-management
$ cd api-management/
$ oc new-build --binary --name api-management -e BACKEND_URL=http://127.0.0.1:8081
Specify the OpenShift domain
$ oc set env bc/api-management OS_SUBDOMAIN=<OPENSHIFT-DOMAIN>

#Using CDK3
$ oc set env bc/api-management OS_SUBDOMAIN=$(minishift ip).nip.io

#Example: OS_SUBDOMAIN=192.168.64.11.nip.io
$ oc set env bc/api-management OS_SUBDOMAIN=192.168.64.11.nip.io

Create a custom API Management instance

$ oc start-build api-management --from-dir=. --follow
$ oc new-app api-management
$ oc expose svc/api-management --name api-bonjour
$ oc expose svc/api-management --name api-hola
$ oc expose svc/api-management --name api-ola
$ oc expose svc/api-management --name api-aloha
(Optional) Enable Readiness probe
$ oc set probe dc/api-management --readiness --get-url=http://:8081/status/ready

Tell frontend to enable API Management

$ oc set env dc/frontend ENABLE_THREESCALE=true

Test the API Management Integration

After enabling the API Management use case, you will see a new Tab (or two if you haven’t previously enabled SSO) containing the new scenario.

  • Click in the API Management tab and you will see a new panel with the information of your deployed services.

  • Click the Refresh results link, if you are not logged in, you will see the services failing with an "Unauthorized" error.

  • Log in using the link in the top right corner using the user/user credentials.

  • After the page refresh click again in the API Management tab.

  • Click the Refresh Results link to call the managed API endpoints. You will see the same results as calling them from the browser tab.

  • Click the link again 6 more times in less than a minute.

Did you notice that now the bonjour service failed with a HTTP 429 Too Many Requests error? The 3scale APIcast allows you to gate (secure or protect) your endopoint without the need to change or add new endpoint in your code. You can proxy your service and add policies, like enabling CORS, doing URL Rewrite or edge rate limiting with a simple configuration.