API overview
The HTTP routes a Gateway serves and the messages the MDK Protocol carries
Overview
MDK exposes two programmatic surfaces: HTTP at the Gateway, and MDK Protocol messages between the Gateway, the Kernel and Workers. This page points to the specification for each.
Gateway HTTP API
The HTTP reference and OpenAPI 3.1 document for the Gateway's sign-in routes, and where each app documents its own routes
Protocol messages
The envelope schema, a worked request and response, and the actions the MDK Protocol carries
Where the HTTP specifications live
The Gateway's HTTP reference and its OpenAPI 3.1 document are generated from the code that serves the routes, and they are published in the MDK repository on GitHub. Gateway HTTP API links to each document and names the source it is generated from.
Next steps
- Understand how the layers fit together: the narrative behind the Gateway, the Kernel and Workers
- Look up a Kernel module: what each module inside the Kernel is responsible for
- Declare an app's routes: the route table that an app's HTTP reference is generated from
- Look up a command or flag: every
mdkcommand, grouped asmdk --helpgroups them