Routing

Jinjat generates API routes from your directory structure of analyses. For the following dbt project:

$ tree
├── analyses
│   └── example_endpoint.sql
└── dbt_project.yml

dbt_project.yml

name: jaffle_shop
version: 0.1
analysis-paths: ["analyses"]

Jinjat will generate the following API endpoint:

curl http://127.0.0.1:8581/0.1/jaffle_shop/example_endpoint

The files and directories that have _ prefix is treated as path parameters. Let's say that you have the following file structure:

$ tree
├── analyses
│   ├── crud
│   │   ├── _create_customers.sql
│   │   ├── _id
│   │   │   └── _get_customer.sql
│   │   ├── _list_customers.sql
│   │   └── schema.yml
└── dbt_project.yml

analyses/crud/schema.yml

version: 2

analyses:
  - name: _create_customers
    config:
      jinjat:
        method: post
  - name: _get_customer
    config:
      jinjat:
        method: get
  - name: _list_customers
    config:
      jinjat:
        method: get

The endpoints will be mapped as follows:

GET  /0.1/jaffle_shop/crud       -->   _list_customers.sql
GET  /0.1/jaffle_shop/crud/[:id] -->   _id/_get_customer.sql
POST /0.1/jaffle_shop/crud       -->   _create_customers.sql

You can access your path parameters as follows:

select * from users where id = {{ jinjat.request().params.id }}

info

In order to secure your API, you should write OpenAPI specification for your analyses. Read more aobut how OpenAPI integration works.

Static files

If you have a directory called ./static in your dbt project directory, Jinjat will serve all the files inside the directory.

System query parameters

_limit

Limits number of returns from the API

Example:

curl http://127.0.0.1:8581/0.1/jaffle_shop/example_endpoint?_limit=100

_json_columns

Parses columns as JSON

Example:

curl http://127.0.0.1:8581/0.1/jaffle_shop/example_endpoint?_json_columns=[json_col]

tip

If you want to see the columns and raw data returned from your query, you can pass _debug query parameter as follows:

curl http://127.0.0.1:8581/0.1/jaffle_shop/example_endpoint?_debug