{"id":18838837,"url":"https://github.com/openapi-ui/nodejs-openapi-ui","last_synced_at":"2026-01-07T15:52:05.275Z","repository":{"id":240330993,"uuid":"801433381","full_name":"openapi-ui/nodejs-openapi-ui","owner":"openapi-ui","description":"A middleware collection for NodeJS using OpenAPI-UI","archived":false,"fork":false,"pushed_at":"2024-06-04T09:11:50.000Z","size":333,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-05T06:15:35.371Z","etag":null,"topics":["express-openapi-ui","hono-openapi-ui","nestjs-openapi-ui","openapi-ui","swagger-ui"],"latest_commit_sha":null,"homepage":"http://www.openapi-ui.com","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/openapi-ui.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-05-16T08:13:57.000Z","updated_at":"2024-06-05T08:08:16.000Z","dependencies_parsed_at":"2024-05-18T04:23:36.701Z","dependency_job_id":"6b40f5de-57e6-4d20-863a-f6078cdfa859","html_url":"https://github.com/openapi-ui/nodejs-openapi-ui","commit_stats":null,"previous_names":["openapi-ui/nodejs-openapi-ui"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openapi-ui%2Fnodejs-openapi-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openapi-ui%2Fnodejs-openapi-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openapi-ui%2Fnodejs-openapi-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openapi-ui%2Fnodejs-openapi-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openapi-ui","download_url":"https://codeload.github.com/openapi-ui/nodejs-openapi-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246273514,"owners_count":20750904,"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":["express-openapi-ui","hono-openapi-ui","nestjs-openapi-ui","openapi-ui","swagger-ui"],"created_at":"2024-11-08T02:40:54.273Z","updated_at":"2026-01-07T15:52:05.229Z","avatar_url":"https://github.com/openapi-ui.png","language":"TypeScript","readme":"# NodeJS-OpenAPI-UI\n\nA middleware collection for using the [OpenAPI-UI](https://github.com/rookie-luochao/openapi-ui) with NodeJS\n\n## List of Contents\n\n- List of Contents\n- [Usage](#Usage)\n  - [NestJS](#nestjs)\n  - [Express](#express)\n  - [Hono](#hono)\n- [License](#license)\n\n## Usage\n\n### NestJS\n```ts\nimport { DocumentBuilder, SwaggerModule } from \"@nestjs/swagger\";\nimport { openApiUIReference } from \"@openapi-ui/nestjs-openapi-ui\";\n\nconst app = await NestFactory.create(AppModule);\n\nconst config = new DocumentBuilder()\n  .setTitle('Cats example')\n  .setDescription('The cats API description')\n  .setVersion('1.0')\n  .addTag('cats')\n  .build()\n\nconst document = SwaggerModule.createDocument(app, config);\nSwaggerModule.setup(\"swagger\", app, document, {\n  jsonDocumentUrl: \"/openapi.json\",\n});\n\napp.use(\n  \"/openapi\",\n  openApiUIReference({\n    specPath: \"/openapi.json\",\n  }),\n);\n```\n\nRead more: [@openapi-ui/nestjs-openapi-ui](https://github.com/openapi-ui/nodejs-openapi-ui/tree/main/packages/nestjs-openapi-ui)\n\n### Express\n```ts\nimport { openApiUIReference } from '@openapi-ui/express-openapi-ui';\nimport swaggerJsdoc from \"swagger-jsdoc\";\n\nconst openApiSpec = swaggerJsdoc({\n  definition: {\n    openapi: \"3.0.0\",\n    info: {\n      title: \"Hello World\",\n      version: \"1.0\",\n    },\n  },\n  apis: [\"./src/*.ts\"], // files containing annotations as above\n});\n\napp.get('/openapi.json', (req, res) =\u003e {\n  res.json(openApiSpec);\n});\n\napp.use(\n  '/openapi',\n  openApiUIReference({\n    specPath: '/openapi.json',\n  }),\n);\n```\n\nRead more: [@openapi-ui/express-openapi-ui](https://github.com/openapi-ui/nodejs-openapi-ui/tree/main/packages/express-openapi-ui)\n\n### Hono\n```ts\nimport { openApiUIReference } from '@openapi-ui/hono-openapi-ui';\n\napp.doc('/openapi.json', {\n  info: {\n    title: 'Example API',\n    description: 'Example API description',\n    version: '1.0.0',\n  },\n  openapi: '3.0.0',\n});\n\napp.use(\n  '/openapi',\n  openApiUIReference({\n    specPath: '/openapi.json',\n  }),\n);\n```\n\nRead more: [@openapi-ui/hono-openapi-ui](https://github.com/openapi-ui/nodejs-openapi-ui/tree/main/packages/hono-openapi-ui)\n\n## License\n[MIT](https://github.com/openapi-ui/nodejs-openapi-ui/blob/main/LICENSE)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenapi-ui%2Fnodejs-openapi-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenapi-ui%2Fnodejs-openapi-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenapi-ui%2Fnodejs-openapi-ui/lists"}