# @typebot.io/docusaurus-plugin-openapi

> OpenAPI plugin for Docusaurus.

Latest version **0.6.5** (published 2022-11-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @typebot.io/docusaurus-plugin-openapi
pnpm add @typebot.io/docusaurus-plugin-openapi
yarn add @typebot.io/docusaurus-plugin-openapi
bun add @typebot.io/docusaurus-plugin-openapi
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.6.5 |
| Published | 2022-11-28 |
| First published | 2022-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=14 |
| Dependencies | 16 |
| Unpacked size | 241.8 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 536 |
| Maintainers | baptistearnaud |

## Links

- npm: https://www.npmjs.com/package/@typebot.io/docusaurus-plugin-openapi
- Repository: https://github.com/cloud-annotations/docusaurus-openapi
- Homepage: https://github.com/cloud-annotations/docusaurus-openapi#readme
- Issues: https://github.com/cloud-annotations/docusaurus-openapi/issues
- npm.io page: https://npm.io/package/@typebot.io/docusaurus-plugin-openapi

## Dependencies (16)

- [clsx](https://npm.io/package/clsx.md) ^1.1.1
- [axios](https://npm.io/package/axios.md) ^0.26.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.1.0
- [webpack](https://npm.io/package/webpack.md) ^5.73.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [json-refs](https://npm.io/package/json-refs.md) ^3.0.15
- [@docusaurus/utils](https://npm.io/package/@docusaurus/utils.md) ^2.0.0
- [postman-collection](https://npm.io/package/postman-collection.md) ^4.1.0
- [remark-admonitions](https://npm.io/package/remark-admonitions.md) ^1.2.1
- [openapi-to-postmanv2](https://npm.io/package/openapi-to-postmanv2.md) ^1.2.1
- [@docusaurus/mdx-loader](https://npm.io/package/@docusaurus/mdx-loader.md) ^2.0.0
- [json-schema-resolve-allof](https://npm.io/package/json-schema-resolve-allof.md) ^1.5.0
- [@docusaurus/utils-validation](https://npm.io/package/@docusaurus/utils-validation.md) ^2.0.0
- [@docusaurus/plugin-content-docs](https://npm.io/package/@docusaurus/plugin-content-docs.md) ^2.0.0

## Recent versions

- 0.6.5 (latest) — 2022-11-28
- 0.6.4 — 2022-11-28

## README

<h1 align="center">Docusaurus OpenAPI</h1>

<div align="center">

OpenAPI plugin for generating API reference docs in Docusaurus v2.

</div>

<p align="center">

![](https://user-images.githubusercontent.com/4212769/85324376-b9e3d900-b497-11ea-9765-c42a8ad1ff61.png)

</p>

## Multiple OpenAPI Definitions

To have more than one OpenAPI pages, add additional OpenAPI plugin instances:

```js
/* docusaurus.config.js */

{
  presets: [
    [
      'docusaurus-preset-openapi',
      {
        api: {
          // id: 'cars', // omitted => default instance
          path: 'cars/openapi.json',
          routeBasePath: 'cars',
          // ... other options
        },
      },
    ],
  ],
  plugins: [
    [
      'docusaurus-plugin-openapi',
      {
        id: 'trains',
        path: 'trains/openapi.json',
        routeBasePath: 'trains',
        // ... other options
      },
    ],
    [
      'docusaurus-plugin-openapi',
      {
        id: 'bikes',
        path: 'bikes/openapi.json',
        routeBasePath: 'bikes',
        // ... other options
      },
    ],
  ],
}
```

This will create routes for `/cars`, `/trains` and `/bikes`.

> **Note:** One instance of the plugin is included in the preset. All additional plugin instances will require an `id`.

---
_Source: https://npm.io/package/@typebot.io/docusaurus-plugin-openapi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._