Skip to main content

Getting started

To get started you first need a running installation of Fusio. If you have not already installed Fusio please take a look at the installation page. Fusio is an open source API management platform which helps to create innovative API solutions. Through Fusio you can quickly build a state-of-the-art API, set up a developer portal and monetize your API.

This page will explain the first steps on how to proxy an operation to an internal API. We create an operation at the backend which executes a specific action, a schema which describes the payload and an action which proxies to a remote API.

Creating an action​

To start we create an action. An action is a small function (i.e. like a serverless lambda function) which receives a HTTP request and produces a response. Fusio already contains many prebuilt actions which can solve many tasks, such as, proxy an HTTP request to a remote API or build an API based on a database table. In this example we simply create an action which proxies a remote API:

create_action

Creating a schema​

Next we create a schema to describe the response of our action. This step is optional, but creating a schema is highly recommended. The schema is then the contract to your API consumers; how the request and response format is designed. Internally Fusio uses TypeSchema to describe the JSON format. Through a schema, Fusio can then automatically create an OpenAPI specification or generate a client SDK.

create_schema

Creating an operation​

Lastly, we need to create an operation which then invokes our action. An operation contains meta information like a description, the request and response schemas, and which action should be invoked. In our example we simply select the action and the schema which we have created.

create_schema

API Response​

Now we can call the /me endpoint at our API which then proxies the HTTP request to our remote API and returns the response.

api_response

Conclusion​

This was a first basic example on how to create a simple API endpoint with Fusio. Fusio provides then out of the box many features to build a great API product. We try to provide all features of a modern API solution which you also find at most popular developer portals. Since Fusio can solve many use cases, we have structured our documentation into three parts: