Building the API

Version 22.0.8500


Building the API

Version 22.0.8500


After defining a connection to your data source, follow the steps below to surface the resources of your API.

Surfacing Database Resources

Follow the steps below to use the wizard to model a database as APIs:

  1. Click Settings -> Resources -> Add Resource.
  2. Select a data connection and select a table you want to model as an API.
  3. Select the columns you want to surface in the resource.

Extending Schemas

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

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

Typical Customizations shows how to make modifications like changing column data types or renaming a resource.