MDK Logo

Gateway HTTP routes

Where to find the generated references for the routes a Gateway serves

TL;DR

MDK is agnostic about how you describe an API: it doesn't require a client or an app to adopt OpenAPI. The OpenAPI documents here are one way to describe the HTTP routes a Gateway serves, generated from the code that serves them.

Overview

The Gateway is MDK's HTTP entry point and this page covers its HTTP routes.

A Gateway serves two kinds of HTTP route: its own sign-in routes under /auth, and the routes of each app your stack declares. Each is declared in code: the Gateway's in the route objects it registers, and an app's in its route table (mdk-plugin.json).

The references listed on this page are generated from those declarations, showing what the code serves. Each comes as a Markdown page for people and an OpenAPI 3.1 document. Neither is a reference for MDK as a whole.

References

ReferenceWhat it coversGenerated from
Gateway HTTP API (OpenAPI 3.1)The sign-in routes: request, response, and the status of every error codeThe route objects the Gateway registers
Route-table fieldsEvery field an app's route table can declareThe route-table schema
Route-table schemaThe JSON Schema mdk-plugin.json is checked againstSource; the app runtime's loader stays the authoritative check at startup

Example apps

Each app documents its own routes.

An app doesn't have to generate a reference. These generate theirs from their route tables, as examples of an app set up this way:

AppWhere it livesReference
MVP site's site appThe MVP site example in the MDK repositoryHTTP reference (OpenAPI 3.1)
Reporting appExternal repositorydocs/http-api.md and docs/openapi.json in that repository

The apps MDK ships list where each one documents its routes.

Next steps

On this page