OpenAPI / Swagger spec for REST API

grokify · December 2, 2018, 2:19am

Is there an OpenAPI or Swagger specification for the REST API? I’d like to have one to use to auto-generate SDKs using the OpenAPI Generator project:

I haven’t found one so far so I started working on one, along with a Go SDK.

Here’s my minimal OpenAPI 3.0 spec. We host our own metabase so I just put in an example.com URL in the spec which is designed to be overridden in the config of the SDK.

github.com

grokify/go-metabase/blob/master/codegen/swagger_spec.yaml

openapi: 3.0.0
info:
  version: 1.0.0
  title: Metabase
servers:
  - url: http://example.com/api
paths:
  /api/database:
    get:
      summary: List Databases
      operationId: listDatabases
      tags:
        - database
      description: Fetch all Databases. include_tables means we should hydrate the Tables belonging to each DB. include_cards here means we should also include virtual Table entries for saved Questions, e.g. so we can easily use them as source Tables in queries. Default for both is false.
      parameters:
        - name: include_tables
          in: query
          description: value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
          required: false
          schema:

This file has been truncated. show original

And my Go SDK so far:

If others are interested in working on this together, I can post this to its own repo.

bberacoveo · February 4, 2025, 1:16pm

I took a peek at the metabase code and I found that the openapi spec is available at /api/docs/openapi.json. You also get an interactive documentation at /api/docs/.