In Synatic, you can use the API Builder to design and create your own API definition to build a set of dedicated Routes and EndPoints.

Every API definition will include the OpenAPI (Swagger) specification that the Synatic definition is based on and defines the overall structure of the API.

In this tutorial, we are first going to create the basic root definition of the API.

Synatic - API Create

This implies that we configure only the following:

  • The APIs Title and description.

  • The API type.

Once the basic Portal API definition is in place, you can then start adding the rest of the API components in the API Builder's main tabs:

  1. Info. The APIs service and metadata URLs including the API type.

  2. Tags. Tags are used to organize the Endpoints and Routes in the Paths option.

  3. Security Schemes. Security schemes are created to manage various authorization levels. The goal is to describe the security requirements for a given API operation.

  4. An IP Whitelist may be configured to limit access to the API from trusted IP addresses only.

  5. The Path for a Flow to retrieve all books.
    - Source connection. Although this component is not part of the API, it is used in the Synatic Source flows when building the API path endpoints and routes.

  6. The Path for a parameterized Synatic Flow.
    - Source connection. Although this component is not part of the API, it is used in the Synatic Source flows when building the API path endpoints and routes.

  7. Schema. The schema is metadata that describes how our data is structured.
    - Most databases implement some form of schema which will help you to define your APIs data in a more structured manner.
    - You can connect various components of your API development and testing process to your schema,


Useful Tutorials

Revisit the Getting Started page for a refresher.

Read more about the API Builder here.


< API Builder Tutorial API Info Tab >

Did this answer your question?