mule api gateway overview

www.sanjeetpandey.com


Prepared by – Sanjeet Pandey

Mule API Gateway Overview


Design API

• RAML stands for RESTful API Modeling Language.• RAML is a simple and succinct way of describing practically-RESTful APIs. • It encourages reuse, enables discovery and pattern-sharing, and aims for merit-based

emergence of best practices• RAML is built on broadly-used standards such as YAML and JSON and is a non-proprietary,

vendor-neutral open spec.• API Designer is the Anypoint Platform for APIs custom environment specifically dedicated to

designing and writing an API definition in RAML.

2


Building API

• Mule ESB allows building an API using APIKit.• APIkit is an open-source, declarative toolkit specially created to facilitate REST API

implementation. • It is a simple framework that caters to API-first development, • It enforces good API implementation practices. Rather than spending weeks or months

building an API, you can use this toolkit to develop, document, and test an API within a few days or even hours

3


Deploying API

• Once an API is built, Anypoint platform allows deploying your API on on-premise or cloud platform.

• API Gateway is specifically built to deploy a RAML based API implementation or creating a proxy for an existing API. Following are the possible configurations.

4


• Once a URL is defined for your API, the proxy application is deployed in API Gateway for monitoring and managing your API

5


Managing API

• Mule supports defining several run time policies against your API. Some of the common most popular policies are as follows:

• HTTP Basic Authentication• LDAP Security Manager• IP Whitelist• IP Blacklist• Rate Limiting• Throttling• Client ID Enforcement• External OAuth 2.0 Token Validation Policy

6


Managing API

• Mule also supports defining and managing SLA’s and API versions.• An organisation can create their own SLA tiers and define rate limits for APIs. • Based on API consumer’s subscriptions, corresponding SLA can be mapped against an API.• It is very easy to create new versions of an API and define different set of polices for new

version of API if required.

7


API Gateway

8


Analyse API

• API Gateway automatically generates analytics of the API usage• It allows you to view

• no. of times API has been called during a selected interval• Location from where API is consumed• Name of the application and platform which is consuming your API

• It allows to create customer reports and charts based on business requirement which helps in taking critical business decisions

• It also allows you to create custom dashboards to provide relevant analytics that a particular business user may be interested in.

9


Engaging Users

• To engage with the consumers of your API, Anypoint platform allows to create API portal for your API.

• There are three kinds of elements you can add to build up the content of your portal:

• Adding Pages: Write plain markdown text, ideal for describing what your API does in broad terms, or to communicate any other information your users may find useful.

• API Reference: If your API has a RAML definition attached to it in its API Version Details page, you can add an automatically generated interactive console that not only lists and describes the possible calls your API supports, it can even be used by your users to perform live calls to it.

• Adding an API Notebook: A versatile interactive tool, ideal for writing tutorials about how to use your API or even about how to integrate it with other services

10

www.sanjeetpandey.com 11

mule api gateway overview

Technology