![Version][version-badge]
[![License][license-badge]][license-url]
[![LinkedIn][linkedin-badge]][linkedin-url]
[![Twitter][twitter-badge]][twitter-url]
![Commit Activity][commit-activity-badge]
![Last Commit][last-commit-badge]
![CircleCI][circleci-badge]
[![Community][community-badge]][community-url]
[![Documentation][docs-badge]][docs-url]
---
Gravitee API Management (also called Gravitee APIM)
is a flexible, lightweight, and blazing-fast Open Source solution that helps your organization control who, when, and how users access your APIs. \
Effortlessly manage the lifecycle of your APIs.
Download API Management to document, discover, and publish your APIs.
Different ways to start using Gravitee APIM:
| Tool | Target |
|------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Gravitee Cloud | 
|
| [Helm Chart][Helm-Chart-url] | 
|
| [docker-compose / make][quick-setup] | 
|
---
[Installation](https://documentation.gravitee.io/apim/getting-started/local-install-with-docker) | [Documentation](https://documentation.gravitee.io/apim) | [Community](https://community.gravitee.io/) | [Contributing](./CONTRIBUTING.adoc) | [License](./LICENSE.txt) | [Website][gravitee-url]
---
## Getting Started
Do you only have a few minutes or want to try it out without installation or configuration?
Gravitee Cloud has you covered. Try our Saas offer with a [free trial][free-trial-url] today!
If you prefer to use Gravitee APIM on your own infrastructure with Docker, follow the steps below.
1) Clone the Gravitee APIM repository
```sh
git clone --depth=1 https://github.com/gravitee-io/gravitee-api-management
cd gravitee-api-management/docker
```
2) Start the Gravitee Console, Portal and Gateway with a MongoDB database
- Run the `Make` command
```sh
make mongodb
```
- Or the `Docker` command
```sh
cd quick-setup/mongodb && docker compose down -v && docker compose pull && docker compose up -d
```
3. Gravitee APIM is now up and running!
Let's explore some of the subcomponents you've deployed:
- `:4100` - [Portal UI](http://localhost:4100) ~ A catalog of your APIs, complete with documentation and more.
- `:8084` - [Console UI](http://localhost:8084) ~ The administrative interface for managing your APIs.
- `:8082` - Gateway ~ Gravitee's powerful API gateway.
- `:8083` - [APIM Backend](http://localhost:8083/portal/openapi) ~ Backend for both the Portal and Console UIs.
Default credentials: `admin` / `admin`
\
What's next?
[Follow our documentation](https://documentation.gravitee.io/apim/how-to-guides) and learn how to create an API, add a Policy,... and more!
4. 💡 Tips (Optional)
>💡 Tip 1: Use your **Enterprise License**
If you have an Enterprise License, you can export it as a Base64-encoded environment variable or move your license file into `docker/quick-setup/mongodb/.license` to gain full access to Gravitee APIM features.
```sh
export LICENSE_KEY=*****
```
>💡 Tip 2: Issue when starting Gravitee APIM
If you're having an issue during `.license` folder creation (using Rancher Desktop for example), please run:
```sh
make prepare TARGET=mongodb
```
## Features
Hold Nothing Back!
- **Register your API**: Create and register APIs in a few clicks to easily expose your secured APIs to internal and external consumers.
- **Configure policies using flows**: Gravitee.io API Management provides over 50 pre-built policies to effectively shape
traffic reaching the gateway according to your business requirements.
- **Developer portal**: Build the portal that your developers want with a custom theme, full-text search, and API documentation.
- **Analytics dashboard**: The out-of-the-box dashboards give you a 360-degree view of your API. You can also build your own
dashboards from Gravitee.io or use all metrics with external tools like Grafana or Kibana.
- **Register applications**: Users and administrators can register applications for consuming APIs with ease. Gravitee.io
provides advanced dynamic client registration to link API Management and Access Management effectively.
- **Secured plans**: Create plans to define the rate limits, quotas, and security policies that apply to your APIs.
[![][gravitee-features]][gravitee-url]
[gravitee-url]: https://www.gravitee.io
[gravitee-features]: https://www.gravitee.io/hubfs/Spiralyze/assets/hero_1002.png
[free-trial-url]: https://eu-auth.cloud.gravitee.io/cloud/register?response_type=code&client_id=fd45d898-e621-4b12-85d8-98e621ab1237&state=enlSaG1YWThMfmc4QXFLZE5aZGdpYUJrcF9VR0tGa3ZRfjBjWm12a2pXY1Bj&redirect_uri=https%3A%2F%2Feu.cloud.gravitee.io&scope=openid+profile+email+offline_access&code_challenge=Zqs-oyj0nSZXIt__zhOTZRmpoR2ShAaQRWksGEQeIYQ&code_challenge_method=S256&nonce=enlSaG1YWThMfmc4QXFLZE5aZGdpYUJrcF9VR0tGa3ZRfjBjWm12a2pXY1Bj
[quick-setup]: docker/README.md
[Helm-Chart-url]: https://documentation.gravitee.io/apim/hybrid-installation-and-configuration-guides/next-gen-cloud/kubernetes
[license-badge]: https://img.shields.io/github/license/gravitee-io/gravitee-api-management?style=flat&label=license&color=FF8A00
[license-url]: https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt
[linkedin-badge]: https://img.shields.io/badge/LinkedIn-Follow-blue?style=flat&color=22A3B3
[linkedin-url]: https://www.linkedin.com/company/gravitee-io
[twitter-badge]: https://img.shields.io/badge/Twitter-Follow-blue?style=flat&color=22A3B3
[twitter-url]: https://twitter.com/intent/follow?screen_name=graviteeio
[community-badge]: https://img.shields.io/badge/community-join-F76C6C?style=flat
[community-url]: https://community.gravitee.io
[docs-badge]: https://img.shields.io/badge/documentation-see-F76C6C?style=flat
[docs-url]: https://documentation.gravitee.io/apim
---
[version-badge]: https://img.shields.io/github/v/tag/gravitee-io/gravitee-api-management?style=flat&label=version&color=FF8A00
[commit-activity-badge]: https://img.shields.io/github/commit-activity/m/gravitee-io/gravitee-api-management?style=flat&color=F76C6C
[last-commit-badge]: https://img.shields.io/github/last-commit/gravitee-io/gravitee-api-management?style=flat&color=F76C6C
[circleci-badge]: https://img.shields.io/circleci/build/github/gravitee-io/gravitee-api-management?style=flat&color=F76C6C 