Building the API

Version 23.0.9145


Building the API


After you define a connection to your data source, perform the steps in the following sections to surface the resources of your API.

Surfacing Database Resources

Follow these steps to use the wizard to model a database as an API:

  1. Select Settings > Resources > Add Resource in the CData API Server Administration Console.

  2. Select a data connection.

  3. Select a table that you want to model as an API.

  4. Select the columns that you want to surface in the resource.

Extending Schemas

The resource is defined in a schema, which you can extend easily without regenerating it 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 information block that contains the definitions of resource columns

  • the data connection

  • methods that correspond to HTTP methods and call data-processing operations

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