Feature
OpenAPI embed
Turn an OpenAPI or Swagger spec into a reference page, or generate the same pages as MDX from the command line.
- Point the embed at an OpenAPI or Swagger URL and it renders each endpoint with its parameters and response fields, without hand-writing API documentation.
- The npm run openapi:import command writes that same reference as MDX pages you can edit, one page per tag in the spec.
- OpenAPI 3.0, 3.1, 3.2 and Swagger 2.0 are accepted, and a document that fails validation is rejected rather than rendered.
- A Postman collection downloads straight from the rendered page, so a reader can call the API without copying endpoints by hand.
- Both paths resolve the spec address first, refuse private and loopback ranges, pin the request to the address that passed, and cap how much they download.
Our documentation site is built with OwnDocs, running the same code you receive.