Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apiman/apiman

Extensible and flexible API Management. Add your own functionality with simple Java plugins.
https://github.com/apiman/apiman

api-gateway api-management api-manager apiman java jvm

Last synced: 3 days ago
JSON representation

Extensible and flexible API Management. Add your own functionality with simple Java plugins.

Awesome Lists containing this project

README 

        
![Verify Build Workflow](https://github.com/Apiman/apiman/workflows/Verify%20Build%20Workflow/badge.svg)

[![Apiman Cypress](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/tpeh3n/master&style=flat&logo=cypress)](https://dashboard.cypress.io/projects/tpeh3n/runs)



# Apiman (Open Source API Management)



**⚡️⚡️ Apiman 4 is under active development ⚡️⚡️**



Apiman is a flexible and open source API Management platform.



With just a few clicks you can get Apiman running, putting a platform at your fingertips that covers the whole API Management lifecycle. Whether you want to offer existing APIs to external consumers in a secure way, or have a centralised location to discover and govern APIs, Apiman has you covered.



But that's not all. Apiman is designed to be easy to customise, and you can implement your own functionality by writing simple Java plugins.



## 🗞️ Apiman Newsletter



Did you know, we have an [Apiman newsletter now](https://www.apiman.io/#newsletter)! We'll inform you of the latest Apiman releases as soon as they happen, along with great Apiman-related content. The latest Apiman news, blogs, tutorials, software engineering topics, and more. No spam, no nonsense.



## ⚡️ Quick links



* [Download Apiman](https://www.apiman.io/download.html)

* [Read the latest Apiman Blogs](https://www.apiman.io/blog/)

* [Get Support](https://www.apiman.io/support.html)

* [Talk Apiman](https://github.com/apiman/apiman/discussions)



## 🐒 Monorepo



⚠️ We may move stuff around as we settle on a finalised monorepo structure post-merge.



* [Apiman Containers/Docker Images](https://github.com/apiman/apiman/tree/master/containers)

* [Apiman Plugins](https://github.com/apiman/apiman/tree/master/plugins)

* [Apiman Developer Portal](https://github.com/apiman/apiman/tree/master/portal/ui)

* [Apiman Manager](https://github.com/apiman/apiman/tree/master/manager)

* [Apiman Gateway](https://github.com/apiman/apiman/tree/master/gateway)

* [Apiman Distributions (packaged binaries we ship)](https://github.com/apiman/apiman/tree/master/distro)



## 📖 Requirements



- Java 11+

- To build Apiman with tests: Docker or an equivalent container engine. This is for running tests with [testcontainers](https://www.testcontainers.org/supported_docker_environment/). 

- Naturally, if you're using an Apiman container, you'll need it for runtime too!



## 🏃‍♂️ Quickstart



You can look at the Apiman [quickstarts on apiman.io](https://www.apiman.io).



Or, you can build and run our 'server-all' quickstart to try everything out immediately.



Here's what you need to do:



```bash

echo "Cloning Apiman"

git clone https://github.com/apiman/apiman.git && cd apiman



echo "Building Apiman"

./fastbuild.sh



echo "Starting a Keycloak container with a demo Apiman realm"

cd tools/server-all/target/docker

docker compose up -d



echo "Starting Apiman WildFly Quickstart" && cd ../

./wildfly-dev-server/bin/standalone.sh

```



Once Apiman has started up, and if all went well, you can point your browser to the API Manager via http://localhost:8080/apimanui/ and log in (either register a new user or log in as the admin):



* Username: `admin`

* Password: `admin123!`



You can log into the Keycloak admin console via http://localhost:8085/admin (same credentials as above).



This quickstart seeds a bunch of content into apiman. This is not strictly necessary, but it does populate the API Manager with some data so that it doesn't feel so lonely the first time you log in.



There's also a handy echo service available at http://localhost:8080/services/echo - it's useful for demos. You're welcome!



⚠️ Please don't use Apiman's default usernames, passwords, keys, certificates, etc., in production.



## ⚒️ Build Apiman



### Fast and easy



The easiest way to build quickly (without tests) is to run our [fastbuild script](https://github.com/apiman/apiman/blob/master/fastbuild.sh). It's in the root of the project. If you have [mvnd](https://github.com/apache/maven-mvnd/) the build will be faster.



```shell

git clone https://github.com/apiman/apiman.git && cd apiman

./fastbuild.sh 

```



### I want to run the tests



First, build the parent pom (it's in `/parent`), then you can build the main project from the top level.



```shell

echo "Building Apiman Parent..."

cd parent

../mvnw clean install



cd ..

echo "Building the main Apiman project..."

./mvnw clean install

```



## 👷 Contribute to Apiman



Apiman is open source, and we welcome anybody who wants to participate and contribute!



If you want to fix a bug or make any changes, please log an issue in [GitHub Issues](https://github.com/apiman/apiman/issues) describing the bug or new feature. 



You can also [join our discussion forums](https://github.com/apiman/apiman/discussions) if you want help, or to discuss a more complex issue.



There are [lots of different workflows for contributing](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). Feel free to use one that suits you. We're endeavouring to pull together a more detailed contribution document that we'll upload soon 🙌.



## 🔎 Developer Portal



Apiman also comes with a skinnable developer portal which you can let external developers sign up to your APIs in a streamlined API marketplace experience.



## 🙋 Looking for support?



Check out [Apiman's support page](https://www.apiman.io/support.html) where you can find Apiman experts to help you.