gatsby-openapi

A mono-repo with a set a gatsby plugins that can be used to build API docs from an OpenAPI specification.

NOTE: This repo is in the very early stages of development.

Plugins

gatsby-source-openapi: Parse an OpenAPI 3 specification and create the gatsby graphql nodes.
gatsby-theme-openapi-core: Creates the theme pages.
gatsby-theme-openapi-theme-ui: Renders the OpenAPI docs using theme-ui.

Examples

example-theme-ui: An example site using the gatsby-theme-openapi-theme-ui theme

Goals

Provide a framework for building API docs with full customisation capabilities (not just tweaking theme variables)
Provide some good default themes
Provide features to render in a single page, or multiple pages
Provide a CLI utility to easily bootstrap/scaffold

Developing

This is a lerna project. Common dependencies are hoisted into the root node_modules directory. This means you must re-bootstrap the project (npm run boostrap) after installing any dependencies into any of the packages.

Getting Started

# install lerna dependencies
npm install

# install & hoist package dependencies (this can take a long time)
npm run bootstrap

# run the example site
npm start

Build the example site

npm run build

Troubleshooting

Error sourcing OpenAPI data: security.map(...).flat is not a function

This usually means you're using an older version of node. Use the version as specified in .nvmrc or within package.json.

License

MIT License