8. Schema

A schema is metadata that describes how data is structured.

Praise Magidi avatar
Written by Praise Magidi
Updated over a week ago

Schemas are an organized framework of the information being requested from or submitted to an API.

  • Most databases implement some form of schema which will help define the API's data in a more structured manner.

  • You can connect various components of your API development and testing process to your schema.

To build a schema, click plus button adjacent to the Schemas tab and provide a Schema Name. There are two options to build the scheme; either Import Schema or Create Manually.

Import Schema

A schema may be imported from a Buffer if one is already configured. To import a schema, follow these instructions:

  1. Click the Select a Buffer dropdown field and select the relevant Buffer.

  2. Click Import Schema to begin the import process from the Buffer.

Create Manually

A schema may also be created manually using the Designer. To create a schema, follow these instructions:

  1. Select the designer tab.

  2. Click the + icon and enter each field you want in your schema.

  3. Enter a name for each field.

  4. Select the data type for each field.

  5. Select the required marker for each field.

  6. Click Save Schema to confirm schema.

Watch the video below to learn how to create a schema manually.


Useful Tutorials

Revisit the Getting Started page for a refresher.

Read more about the API Builder here.


Did this answer your question?