Membrane API Gateway Tutorials

Explore and learn Membrane with short tutorials that are easy to follow. Each tutorial explains an API Gateway concept or feature.

Getting Started Tutorial

1. Download and unpack a release, then start the first example:

$ cd tutorials/getting-started
$ ./run-docker.sh -c 10-First-API.yaml
10:38:00,812  INFO 3 main ApiInfo:39 {} - Started 1 API:
10:38:00,813  INFO 3 main ApiInfo:41 {} -   0.0.0.0:2000  http://127.0.0.1:2000
10:38:00,814  INFO 3 main RouterCLI:457 {} - Membrane API Gateway 7.6.1 up and running!

2. Follow the instructions in 10-First-API.yaml

3. Continue with the other samples in the tutorials/getting-started folder.

Prefer Java over Docker? Run ./membrane.sh -c 10-First-API.yaml. See the Java setup guide.

Advanced Tutorials

After you have completed this tutorial, follow the JSON, OAuth2, OpenAPI,... tutorials in any order, depending on what you want to achieve.

Problems?

See the Troubleshooting.