{"id":16293614,"url":"https://github.com/badsyntax/gatsby-openapi","last_synced_at":"2026-05-09T14:13:26.752Z","repository":{"id":136894311,"uuid":"289315099","full_name":"badsyntax/gatsby-openapi","owner":"badsyntax","description":"A mono-repo with a set a gatsby plugins that can be used to build API docs from an OpenAPI specification.","archived":false,"fork":false,"pushed_at":"2020-08-30T18:22:18.000Z","size":3767,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-15T05:15:02.420Z","etag":null,"topics":["gatsby","openapi"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/badsyntax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-21T16:26:15.000Z","updated_at":"2020-08-28T22:18:27.000Z","dependencies_parsed_at":"2023-04-14T01:31:03.932Z","dependency_job_id":null,"html_url":"https://github.com/badsyntax/gatsby-openapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fgatsby-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fgatsby-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fgatsby-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/badsyntax%2Fgatsby-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/badsyntax","download_url":"https://codeload.github.com/badsyntax/gatsby-openapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248027412,"owners_count":21035594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gatsby","openapi"],"created_at":"2024-10-10T20:11:52.674Z","updated_at":"2026-05-09T14:13:21.716Z","avatar_url":"https://github.com/badsyntax.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gatsby-openapi\n\n![Build and Deploy](https://github.com/badsyntax/gatsby-openapi/workflows/Build%20and%20Deploy/badge.svg)\n\nA mono-repo with a set a gatsby plugins that can be used to build API docs from an OpenAPI specification.\n\n__NOTE:__ This repo is in the very early stages of development.\n\n## Plugins\n\n- [gatsby-source-openapi](./packages/gatsby-source-openapi): Parse an OpenAPI 3 specification and create the gatsby graphql nodes.\n- [gatsby-theme-openapi-core](./packages/gatsby-theme-openapi-core): Creates the theme pages.\n- [gatsby-theme-openapi-theme-ui](./packages/gatsby-theme-openapi-theme-ui): Renders the OpenAPI docs using `theme-ui`.\n\n## Examples\n\n- [example-theme-ui](./packages.example-theme-ui): An example site using the [gatsby-theme-openapi-theme-ui]('./packages/gatsby-theme-openapi-theme-ui) theme\n\n## Goals\n\n- Provide a framework for building API docs with full customisation capabilities (not just tweaking theme variables)\n- Provide some good default themes\n- Provide features to render in a single page, or multiple pages\n- Provide a CLI utility to easily bootstrap/scaffold\n\n## Developing\n\nThis 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.\n\n### Getting Started\n\n```sh\n# install lerna dependencies\nnpm install\n\n# install \u0026 hoist package dependencies (this can take a long time)\nnpm run bootstrap\n\n# run the example site\nnpm start\n```\n\n### Build the example site\n\n```sh\nnpm run build\n```\n\n### Troubleshooting\n\n`Error sourcing OpenAPI data: security.map(...).flat is not a function`\n\nThis usually means you're using an older version of node. Use the version as specified in `.nvmrc` or within `package.json`.\n\n## License\n\nMIT License\n\nCopyright (c) 2020 Richard Willis","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadsyntax%2Fgatsby-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbadsyntax%2Fgatsby-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbadsyntax%2Fgatsby-openapi/lists"}