Build Your First API

Version 24.3.9106


Build Your First API


After defining a connection to your data source, you can surface the resources of your API. You can use the wizard in the administration console to generate schemas for reading and writing to your data store.

Surfacing Database Resources

To use the wizard to model a database as an API:

  1. Click Resources > Add Resource.
  2. Select a table you want to model as an API.
  3. Select the columns you want to surface in the resources.

The resource is defined in a schema, which can easily be modified or extended without regenerating from the database. You can modify the schema by clicking the resource or Edit in the entry for the resource. The generated schema contains the two essential components of a schema:

  • An info block containing resource columns definitions
  • Methods that correspond to HTTP methods and call data processing operations