API Gateway Tutorials

The fastest and most enjoyable way to learn how to use Membrane API Gateway is through the tutorials. Start with the Getting Started tutorial. After that, you can follow the other tutorials in any order, depending on what you want to achieve.

Getting Started

Learn the basics: routing, logging, message flow, templating, and OpenAPI.

1. Install Membrane first (~2 minutes).
2. Open the Membrane folder membrane-api-gateway-7.X.X in a terminal.
3. Go to the tutorial folder:
   

   cd tutorials/getting-started

4. Open 00-First-API.yaml in an editor with YAML support (for example Visual Studio Code or IntelliJ).
5. Follow the instructions inside the file.

Next, continue with the advanced tutorial.

Advanced API Gateway Functions

The advanced tutorial covers path parameters, URL rewriting, redirects, conditionals and scripting.

JSON

JsonPath and JSON message transformations are explained in the JSON tutorial.

XML

XML-to-JSON transformations and XPath are covered in the XML tutorial.

SOAP

Note: This tutorial is still in progress.

If you need to integrate legacy web services via SOAP, use the SOAP tutorial. Otherwise, you can skip it.