{"id":13566831,"url":"https://github.com/cloud-annotations/docusaurus-openapi","last_synced_at":"2025-05-14T10:07:20.240Z","repository":{"id":37837266,"uuid":"273958287","full_name":"cloud-annotations/docusaurus-openapi","owner":"cloud-annotations","description":"🦕 OpenAPI plugin for generating API reference docs in Docusaurus.","archived":false,"fork":false,"pushed_at":"2025-01-03T14:13:03.000Z","size":2219,"stargazers_count":522,"open_issues_count":50,"forks_count":83,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-05T14:01:35.585Z","etag":null,"topics":["api-documentation","documentation-generator","docusaurus","hacktoberfest","openapi","openapi3","plugin","react","swagger"],"latest_commit_sha":null,"homepage":"https://docusaurus-openapi.netlify.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloud-annotations.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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-06-21T18:06:52.000Z","updated_at":"2025-03-30T10:52:16.000Z","dependencies_parsed_at":"2023-02-10T16:16:09.063Z","dependency_job_id":"23fb3c81-01b2-4168-bee9-42c13423c221","html_url":"https://github.com/cloud-annotations/docusaurus-openapi","commit_stats":{"total_commits":202,"total_committers":22,"mean_commits":9.181818181818182,"dds":0.4356435643564357,"last_synced_commit":"aafdc8a550fa882c379978c19c6d5128c49bad62"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-annotations%2Fdocusaurus-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-annotations%2Fdocusaurus-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-annotations%2Fdocusaurus-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloud-annotations%2Fdocusaurus-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloud-annotations","download_url":"https://codeload.github.com/cloud-annotations/docusaurus-openapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248173808,"owners_count":21059594,"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":["api-documentation","documentation-generator","docusaurus","hacktoberfest","openapi","openapi3","plugin","react","swagger"],"created_at":"2024-08-01T13:02:17.605Z","updated_at":"2025-04-12T15:32:15.221Z","avatar_url":"https://github.com/cloud-annotations.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003eDocusaurus OpenAPI\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n\nOpenAPI plugin for generating API reference docs in Docusaurus.\n\n[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cloud-annotations/docusaurus-plugin-openapi/blob/HEAD/LICENSE)\n[![npm latest package](https://img.shields.io/npm/v/docusaurus-preset-openapi/latest.svg)](https://www.npmjs.com/package/docusaurus-preset-openapi)\n[![npm downloads](https://img.shields.io/npm/dm/docusaurus-plugin-openapi.svg)](https://www.npmjs.com/package/docusaurus-preset-openapi)\n[![build](https://github.com/cloud-annotations/docusaurus-plugin-openapi/actions/workflows/validate.yaml/badge.svg)](https://github.com/cloud-annotations/docusaurus-plugin-openapi/actions/workflows/validate.yaml)\n\u003cbr/\u003e\n[![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg)](https://www.cypress.io/)\n[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/cloud-annotations/docusaurus-plugin-openapi/blob/HEAD/CONTRIBUTING.md#pull-requests)\n\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n\n![](https://user-images.githubusercontent.com/4212769/85324376-b9e3d900-b497-11ea-9765-c42a8ad1ff61.png)\n\n\u003c/p\u003e\n\n## Quick Overview\n\n```sh\nnpx create-docusaurus-openapi my-website\ncd my-website\nnpm start\n```\n\n\u003e Coming from `v0.1.0`? See the [migration guide](https://github.com/cloud-annotations/docusaurus-plugin-openapi/releases/tag/v0.2.0).\n\n_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher)_\n\nThen open [http://localhost:3000/](http://localhost:3000/) to see your site.\u003cbr\u003e\nWhen you’re ready to deploy to production, create a minified bundle with `npm run build`.\n\n## Creating a new Site\n\n**You’ll need to have Node 14.0.0 or later version on your local development machine** (but it’s not required on the server). We recommend using the latest LTS version. You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to switch Node versions between different projects.\n\nTo create a new site, you may choose one of the following methods:\n\n- ### npx\n\n  ```sh\n  npx create-docusaurus-openapi my-website\n  ```\n\n  _([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) is a package runner tool that comes with npm 5.2+ and higher)_\n\n- ### npm\n\n  ```sh\n  npm init docusaurus-openapi my-website\n  ```\n\n  _`npm init \u003cinitializer\u003e` is available in npm 6+_\n\n- ### yarn\n\n  ```sh\n  yarn create docusaurus-openapi my-website\n  ```\n\n  _[`yarn create \u003cstarter-kit-package\u003e`](https://yarnpkg.com/lang/en/docs/cli/create/) is available in Yarn 0.25+_\n\nIt will create a directory called `my-website` inside the current folder.\u003cbr\u003e\nInside that directory, it will generate the initial project structure and install the transitive dependencies:\n\n```\nmy-website\n├── blog\n│   ├── 2019-05-28-hola.md\n│   ├── 2019-05-29-hello-world.md\n│   └── 2020-05-30-welcome.md\n├── docs\n│   ├── doc1.md\n│   ├── doc2.md\n│   ├── doc3.md\n│   └── mdx.md\n├── src\n│   ├── css\n│   │   └── custom.css\n│   └── pages\n│       ├── styles.module.css\n│       └── index.js\n├── static\n│   └── img\n├── .gitignore\n├── openapi.json\n├── docusaurus.config.js\n├── babel.config.js\n├── package.json\n├── sidebars.js\n└── README.md\n```\n\n- `/docusaurus.config.js` - A config file containing the site configuration. This can be used to configure the OpenAPI preset\n- `/openapi.json` - The default OpenAPI definition that will be served _(path can be configured in `docusaurus.config.js`)_.\n\nFor more info see [project structure rundown](https://docusaurus.io/docs/installation#project-structure-rundown).\n\nOnce the installation is done, you can open your project folder:\n\n```sh\ncd my-website\n```\n\nInside the newly created project, you can run some built-in commands:\n\n### `npm start` or `yarn start`\n\nRuns the site in development mode.\u003cbr\u003e\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will automatically reload if you make changes to the code.\n\n### `npm run build` or `yarn build`\n\nBuilds the site for production to the `build` folder.\n\nDocusaurus is a modern static website generator that will build the website into a directory of static contents, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Vercel](https://vercel.com/) or [Netlify](https://www.netlify.com/).\n\n## Add to an existing Site\n\n1. Install the dependency\n\n   ```sh\n   npm install docusaurus-preset-openapi\n   ```\n\n2. Edit your `docusaurus.config.js` file to use this preset\n   ```js\n   presets: [\n     [\n       \"docusaurus-preset-openapi\",\n       /** @type {import('docusaurus-preset-openapi').Options} */\n       {\n         api: {\n           path: \"\u003cPATH_TO_YOUR_OPENAPI_DOCUMENT\u003e\",\n           routeBasePath: \"/api\",\n         },\n         docs: {\n           sidebarPath: require.resolve(\"./sidebars.js\"),\n           routeBasePath: \"/\",\n         },\n         theme: {\n           customCss: require.resolve(\"./src/css/custom.css\"),\n         },\n       },\n     ],\n   ];\n   ```\n\n## Popular Alternatives\n\nDocusaurus OpenAPI is great for:\n\n- **Static generation** All OpenAPI operations will be rendered as static pages at build time, giving many performance benefits.\n- **Demo panel** Allow users to try out your API with an interactive demo panel.\n- **Native Docusaurus feel** Built from scratch to work with Docusaurus.\n\nHere are a few common cases where you might want to try something else:\n\n- If you need better support for more advanced OpenAPI features, check out [Redocusaurus](https://github.com/rohit-gohri/redocusaurus/). Redocusaurus embeds the much more mature OpenAPI documentation generator, [Redoc](https://github.com/Redocly/redoc), into Docusaurus as a React component.\n\n## Contributing\n\nWe encourage you to contribute to Docusaurus OpenAPI! Please check out the\n[Contributing to Docusaurus OpenAPI guide](https://github.com/cloud-annotations/docusaurus-plugin-openapi/blob/main/CONTRIBUTING.md) for guidelines about how to proceed.\n\n## License\n\nDocusaurus OpenAPI is released under the [MIT License](https://opensource.org/licenses/MIT).\n","funding_links":[],"categories":["TypeScript","react"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloud-annotations%2Fdocusaurus-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloud-annotations%2Fdocusaurus-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloud-annotations%2Fdocusaurus-openapi/lists"}