{"_id":"@albertigroup/docusaurus-plugin-swagger","_rev":"5-f0ae1c67d993b027d74909b1c06dec3f","name":"@albertigroup/docusaurus-plugin-swagger","dist-tags":{"latest":"1.1.1"},"versions":{"1.0.0":{"name":"@albertigroup/docusaurus-plugin-swagger","version":"1.0.0","keywords":["swagger","docusaurus","docusaurus-plugin"],"author":{"name":"Alberti Group"},"license":"MIT","_id":"@albertigroup/docusaurus-plugin-swagger@1.0.0","maintainers":[{"name":"davide.alberti","email":"dough-versed.6g@icloud.com"}],"homepage":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger#readme","bugs":{"url":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger/issues"},"dist":{"shasum":"59b527128a182cc9dbaeff4cc3fd6e5be265ebe1","tarball":"https://registry.npmjs.org/@albertigroup/docusaurus-plugin-swagger/-/docusaurus-plugin-swagger-1.0.0.tgz","fileCount":9,"integrity":"sha512-OJECEDQrMIrDS0IhoSt4U8V2zuCi99xbm9GfNgLws+t/zoo2LnKEVdBU1aUXxDDh5vKTVyzfdU++YNy60po+uQ==","signatures":[{"sig":"MEUCIQC9gUlh/GDhbFEYHHxbXc8SYOAgv9lXk50M33K8Gkow2AIgFurLTpfZjP0tpMPuzGaqBohR3h23ywEdji5/OmIxUfk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":8228},"main":"dist/index.js","types":"dist/types.d.ts","scripts":{"build":"tsc && cp src/style.css dist/style.css","watch":"tsc -w"},"_npmUser":{"name":"davide.alberti","email":"dough-versed.6g@icloud.com"},"repository":{"url":"git+https://gitlab.com/albertigroup/docusaurus-plugin-swagger.git","type":"git"},"_npmVersion":"10.8.2","description":"Bring Swagger UI inside Docusaurus","directories":{},"_nodeVersion":"20.18.0","dependencies":{"yaml":"^2.8.4","webpack":"^5.106.2","swagger-ui-react":"^5.32.5"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"packageManager":"pnpm@10.33.4","devDependencies":{"typescript":"^6.0.3","@types/node":"^25.6.0","@types/react":"^18.3.28","@docusaurus/types":"^3.10.1","@types/swagger-ui-react":"^5.18.0","@docusaurus/module-type-aliases":"3.10.1"},"peerDependencies":{"react":"^18.0.0","react-dom":"^18.0.0","@docusaurus/core":"^3.10.1"},"_npmOperationalInternal":{"tmp":"tmp/docusaurus-plugin-swagger_1.0.0_1778186041261_0.1184315871410162","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@albertigroup/docusaurus-plugin-swagger","version":"1.0.1","keywords":["swagger","docusaurus","docusaurus-plugin"],"author":{"name":"Alberti Group"},"license":"MIT","_id":"@albertigroup/docusaurus-plugin-swagger@1.0.1","maintainers":[{"name":"davide.alberti","email":"dough-versed.6g@icloud.com"}],"homepage":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger#readme","bugs":{"url":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger/issues"},"dist":{"shasum":"a12b8be0e36c4bc762f137d4d3e77d489769419b","tarball":"https://registry.npmjs.org/@albertigroup/docusaurus-plugin-swagger/-/docusaurus-plugin-swagger-1.0.1.tgz","fileCount":10,"integrity":"sha512-2pg4HNyKkJ3FOUBzVC+vhDoeWq+qjxtB3aZu4QttBpX99RDDw6YOy2RvAv4nY54/hPhKkCIXH5NVdAEyPSknvw==","signatures":[{"sig":"MEYCIQCGNznCxXUSrDhccwE/7n0h/D2/JDlgqXSScPFSmCzd6QIhAOvNOQVpQ5mnax6Gb6+5v7j//rlRCrinbfJm3MxhnVOo","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@albertigroup%2fdocusaurus-plugin-swagger@1.0.1","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"unpackedSize":11090},"main":"dist/index.js","types":"dist/types.d.ts","gitHead":"f1bdbb4ad6ae2595b5fb13ef392e5a88836a85f2","scripts":{"build":"tsc && cp src/style.css dist/style.css && cp README.md dist/README.md","watch":"tsc -w"},"_npmUser":{"name":"GitLab CI/CD","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"gitlab","oidcConfigId":"oidc:dcdea3e6-49c5-4ab7-9c46-459834a7600e"}},"repository":{"url":"git+https://gitlab.com/albertigroup/docusaurus-plugin-swagger.git","type":"git"},"_npmVersion":"11.14.0","description":"Bring Swagger UI inside Docusaurus","directories":{},"_nodeVersion":"24.15.0","dependencies":{"yaml":"^2.8.4","webpack":"^5.106.2","swagger-ui-react":"^5.32.5"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"packageManager":"pnpm@10.33.4","devDependencies":{"typescript":"^6.0.3","@types/node":"^25.6.0","@types/react":"^18.3.28","@docusaurus/types":"^3.10.1","@types/swagger-ui-react":"^5.18.0","@docusaurus/module-type-aliases":"3.10.1"},"peerDependencies":{"react":"^18.0.0","react-dom":"^18.0.0","@docusaurus/core":"^3.10.1"},"_npmOperationalInternal":{"tmp":"tmp/docusaurus-plugin-swagger_1.0.1_1778187556699_0.6687887162980475","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@albertigroup/docusaurus-plugin-swagger","version":"1.0.2","keywords":["swagger","docusaurus","docusaurus-plugin"],"author":{"name":"Alberti Group"},"license":"MIT","_id":"@albertigroup/docusaurus-plugin-swagger@1.0.2","maintainers":[{"name":"davide.alberti","email":"dough-versed.6g@icloud.com"}],"homepage":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger#readme","bugs":{"url":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger/issues"},"dist":{"shasum":"ea37721a06221f697555034ec7f9c91288a6f8fd","tarball":"https://registry.npmjs.org/@albertigroup/docusaurus-plugin-swagger/-/docusaurus-plugin-swagger-1.0.2.tgz","fileCount":9,"integrity":"sha512-SWh3qe8FlkE00u2RhF9c/48sfqy8aodU5baNJy4gEv1gjSQHPEF6YpEtKzKL1FAp6rR6pYu2JOvuAnrI7mM15Q==","signatures":[{"sig":"MEYCIQDwbQP7BLic0GnG+eSKMT8hOH43GXo5gquR4dZhSoXOJwIhAMohk/y7IxY4mxGLSUrFkUW5nmqaBsj7UFceWn05vKh0","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@albertigroup%2fdocusaurus-plugin-swagger@1.0.2","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"unpackedSize":8228},"main":"dist/index.js","types":"dist/types.d.ts","gitHead":"4de69fa949a49a47919608558876e38383cdad5b","scripts":{"build":"tsc && cp src/style.css dist/style.css","watch":"tsc -w"},"_npmUser":{"name":"GitLab CI/CD","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"gitlab","oidcConfigId":"oidc:dcdea3e6-49c5-4ab7-9c46-459834a7600e"}},"repository":{"url":"git+https://gitlab.com/albertigroup/docusaurus-plugin-swagger.git","type":"git"},"_npmVersion":"11.14.0","description":"Bring Swagger UI inside Docusaurus","directories":{},"_nodeVersion":"24.15.0","dependencies":{"yaml":"^2.8.4","webpack":"^5.106.2","swagger-ui-react":"^5.32.5"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"packageManager":"pnpm@10.33.4","devDependencies":{"typescript":"^6.0.3","@types/node":"^25.6.0","@types/react":"^18.3.28","@docusaurus/types":"^3.10.1","@types/swagger-ui-react":"^5.18.0","@docusaurus/module-type-aliases":"3.10.1"},"peerDependencies":{"react":"^18.0.0","react-dom":"^18.0.0","@docusaurus/core":"^3.10.1"},"_npmOperationalInternal":{"tmp":"tmp/docusaurus-plugin-swagger_1.0.2_1778188516830_0.7325929030116622","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@albertigroup/docusaurus-plugin-swagger","version":"1.1.0","keywords":["swagger","docusaurus","docusaurus-plugin"],"author":{"name":"Alberti Group"},"license":"MIT","_id":"@albertigroup/docusaurus-plugin-swagger@1.1.0","maintainers":[{"name":"davide.alberti","email":"dough-versed.6g@icloud.com"}],"homepage":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger#readme","bugs":{"url":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger/issues"},"dist":{"shasum":"73a9e15a4b487abcbe23727e2431fa9fcf9d840e","tarball":"https://registry.npmjs.org/@albertigroup/docusaurus-plugin-swagger/-/docusaurus-plugin-swagger-1.1.0.tgz","fileCount":9,"integrity":"sha512-M+uiWDpQBG/a97W9ebwawsY/kQhLweZqheabH4YS9NfRtxK3bo85xH92qEvxOZ18P3a+RQjO62tmAmrAEBvHuQ==","signatures":[{"sig":"MEYCIQC85r7XWiQZeeyWqaEy8N4XYwIeYb6edgKxc3XGXK0QuQIhAM81ets4ZBdc7UERAQISxgwtnxwoATXbGLGrWL6Y9CEC","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@albertigroup%2fdocusaurus-plugin-swagger@1.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"unpackedSize":8292},"main":"dist/index.js","types":"dist/types.d.ts","gitHead":"0e41ba724b9ebf3e1fd32f2b6b782a784d219f6d","scripts":{"build":"tsc && cp src/style.css dist/style.css","watch":"tsc -w"},"_npmUser":{"name":"GitLab CI/CD","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"gitlab","oidcConfigId":"oidc:dcdea3e6-49c5-4ab7-9c46-459834a7600e"}},"repository":{"url":"git+https://gitlab.com/albertigroup/docusaurus-plugin-swagger.git","type":"git"},"_npmVersion":"11.14.1","description":"Bring Swagger UI inside Docusaurus","directories":{},"_nodeVersion":"24.15.0","dependencies":{"yaml":"^2.8.4","webpack":"^5.106.2","swagger-ui-react":"^5.32.5"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"packageManager":"pnpm@10.33.4","devDependencies":{"typescript":"^6.0.3","@types/node":"^25.6.0","@types/react":"^18.3.28","@docusaurus/types":"^3.10.1","@types/swagger-ui-react":"^5.18.0","@docusaurus/module-type-aliases":"3.10.1"},"peerDependencies":{"react":"^18.0.0","react-dom":"^18.0.0","@docusaurus/core":"^3.10.1"},"_npmOperationalInternal":{"tmp":"tmp/docusaurus-plugin-swagger_1.1.0_1778688205905_0.23957245260784354","host":"s3://npm-registry-packages-npm-production"}},"1.1.1":{"name":"@albertigroup/docusaurus-plugin-swagger","version":"1.1.1","description":"Bring Swagger UI inside Docusaurus","main":"dist/index.js","scripts":{"build":"tsc && cp src/style.css dist/style.css","watch":"tsc -w"},"license":"MIT","packageManager":"pnpm@10.33.4","dependencies":{"swagger-ui-react":"^5.32.5","webpack":"^5.106.2","yaml":"^2.8.4"},"peerDependencies":{"@docusaurus/core":"^3.10.1","react":"^18.0.0","react-dom":"^18.0.0"},"devDependencies":{"@docusaurus/module-type-aliases":"3.10.1","@docusaurus/types":"^3.10.1","@types/node":"^25.6.0","@types/react":"^18.3.28","@types/swagger-ui-react":"^5.18.0","typescript":"^6.0.3"},"repository":{"type":"git","url":"git+https://gitlab.com/albertigroup/docusaurus-plugin-swagger.git"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"keywords":["swagger","docusaurus","docusaurus-plugin"],"author":{"name":"Alberti Group"},"types":"dist/types.d.ts","gitHead":"50aa031190395d7f2f4449342e0e3c82ff4ee107","_id":"@albertigroup/docusaurus-plugin-swagger@1.1.1","bugs":{"url":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger/issues"},"homepage":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger#readme","_nodeVersion":"24.15.0","_npmVersion":"11.14.1","dist":{"integrity":"sha512-2qNRDd21USQM2ilVBdJA4Sk+ikyfCa6lXp1dgYypGDohfwDunL7+IMtG2HN6nYXvf4IpxPjUv1YWzzRy9PF8Jw==","shasum":"4b7d900ad3f703b2b2bfdc5c7b0e8bec9b7882e4","tarball":"https://registry.npmjs.org/@albertigroup/docusaurus-plugin-swagger/-/docusaurus-plugin-swagger-1.1.1.tgz","fileCount":9,"unpackedSize":8616,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@albertigroup%2fdocusaurus-plugin-swagger@1.1.1","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFNDpJEKskw1E9QdfFVWpBycjz+IU0c3R3odgj+uUcm9AiBCZI4wcxCicfX6RWHR66E3UHJFRrBQz5uxK51oxl7SOA=="}]},"_npmUser":{"name":"GitLab CI/CD","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"gitlab","oidcConfigId":"oidc:0faabb89-ad83-4768-856b-8c81f679c0bf"}},"directories":{},"maintainers":[{"name":"davide.alberti","email":"dough-versed.6g@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/docusaurus-plugin-swagger_1.1.1_1778702753814_0.9416642427012067"},"_hasShrinkwrap":false}},"time":{"created":"2026-05-07T20:34:01.175Z","modified":"2026-05-13T20:05:54.380Z","1.0.0":"2026-05-07T20:34:01.422Z","1.0.1":"2026-05-07T20:59:16.851Z","1.0.2":"2026-05-07T21:15:16.991Z","1.1.0":"2026-05-13T16:03:26.100Z","1.1.1":"2026-05-13T20:05:53.965Z"},"bugs":{"url":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger/issues"},"author":{"name":"Alberti Group"},"license":"MIT","homepage":"https://gitlab.com/albertigroup/docusaurus-plugin-swagger#readme","keywords":["swagger","docusaurus","docusaurus-plugin"],"repository":{"type":"git","url":"git+https://gitlab.com/albertigroup/docusaurus-plugin-swagger.git"},"description":"Bring Swagger UI inside Docusaurus","maintainers":[{"name":"davide.alberti","email":"dough-versed.6g@icloud.com"}],"readme":"# @albertigroup/docusaurus-plugin-swagger\n\nA [Docusaurus](https://docusaurus.io/) plugin that renders Swagger UI inline in your documentation site.\n\n## Features\n\n- Renders Swagger UI via a dedicated route in your Docusaurus site\n- Built on [`swagger-ui-react`](https://www.npmjs.com/package/swagger-ui-react) v5\n- TypeScript-first, fully typed plugin and component API\n- Compatible with Docusaurus v3\n\n## Requirements\n\n| Peer dependency    | Version   |\n|--------------------|-----------|\n| `@docusaurus/core` | `^3.10.1` |\n| `react`            | `^18.0.0` |\n| `react-dom`        | `^18.0.0` |\n\n## Installation\n\n```bash\n# pnpm\npnpm add @albertigroup/docusaurus-plugin-swagger\n\n# npm\nnpm install @albertigroup/docusaurus-plugin-swagger\n\n# yarn\nyarn add @albertigroup/docusaurus-plugin-swagger\n```\n\n## Usage\n\n### 1. Register the plugin\n\nIn your `docusaurus.config.ts`:\n\n```ts\nimport type { Config } from '@docusaurus/types';\n\nconst config: Config = {\n  // ...\n  plugins: [\n    [\n      '@albertigroup/docusaurus-plugin-swagger',\n      {\n        id: 'my-api',\n        defaultSpecPath: './swagger/my-api.yaml',\n        routePath: '/api',\n        specFileName: 'my-api.yaml', // used for i18n\n      },\n    ],\n  ],\n};\n\nexport default config;\n```\n\n### 2. Multiple instances\n\nYou can register the plugin multiple times with different `id` values to expose multiple APIs:\n\n```ts\nplugins: [\n  [\n    '@albertigroup/docusaurus-plugin-swagger',\n    {\n      id: 'public-api',\n      defaultSpecPath: './swagger/public-api.yaml',\n      routePath: '/api/public',\n      specFileName: 'public-api.yaml',\n    },\n  ],\n  [\n    '@albertigroup/docusaurus-plugin-swagger',\n    {\n      id: 'admin-api',\n      defaultSpecPath: './swagger/admin-api.yaml',\n      routePath: '/api/admin',\n      specFileName: 'admin-api.yaml',\n    },\n  ],\n],\n```\n\n### 3. i18n\n\nPlace your translated YAML files at:\n\n```\ni18n/{locale}/docusaurus-plugin-swagger/{specFileName}\n```\n\nExamples:\n\n```\ni18n/en/docusaurus-plugin-swagger/public-api.yaml\ni18n/es/docusaurus-plugin-swagger/admin-api.yaml\n```\n\n## Plugin options\n\n| Option            | Type     | Required | Default     | Description                                             |\n|-------------------|----------|----------|-------------|---------------------------------------------------------|\n| `id`              | `string` | No       | `'default'` | Unique plugin instance ID (required for multi-instance) |\n| `defaultSpecPath` | `string` | Yes      | —           | Path to the default locale OpenAPI/Swagger YAML file    |\n| `routePath`       | `string` | Yes      | —           | Base path where Swagger UI will be rendered             |\n| `specFileName`    | `string` | No       | —           | File name used to resolve locale-specific spec files    |\n\n## License\n\nMIT © [Alberti Group](https://albertigroup.it)","readmeFilename":"README.md"}