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:

---

Installation | Documentation | Community | Contributing | License | Website

---

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 today!

If you prefer to use Gravitee APIM on your own infrastructure with Docker, follow the steps below.

1. Clone the Gravitee APIM repository

   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

  make mongodb

• Or the Docker command

   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 ~ A catalog of your APIs, complete with documentation and more.
• :8084 - Console UI ~ The administrative interface for managing your APIs.
• :8082 - Gateway ~ Gravitee's powerful API gateway.
• :8083 - APIM Backend ~ Backend for both the Portal and Console UIs.

Default credentials: admin / admin

What's next? Follow our documentation 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.

   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:

   make prepare TARGET=mongodb

Features

• 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.

---