{"id":14989297,"url":"https://github.com/socketsomeone/nestjs-swagger-koa","last_synced_at":"2025-04-12T01:21:41.126Z","repository":{"id":246865237,"uuid":"824515069","full_name":"SocketSomeone/nestjs-swagger-koa","owner":"SocketSomeone","description":"📦 NestJS module for generating Swagger documentation for Koa applications","archived":false,"fork":false,"pushed_at":"2025-04-11T22:59:11.000Z","size":1094,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T23:35:20.050Z","etag":null,"topics":["adapter","koa","nestjs","swagger"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/nestjs-swagger-koa","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/SocketSomeone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["SocketSomeone"]}},"created_at":"2024-07-05T09:46:23.000Z","updated_at":"2025-04-11T22:59:09.000Z","dependencies_parsed_at":"2024-08-23T23:31:33.238Z","dependency_job_id":"a1e2c422-fbab-40c3-88e3-55af9c6494c3","html_url":"https://github.com/SocketSomeone/nestjs-swagger-koa","commit_stats":{"total_commits":116,"total_committers":3,"mean_commits":"38.666666666666664","dds":"0.14655172413793105","last_synced_commit":"5426e6af9720f8307a0febf5ac5333317655e957"},"previous_names":["socketsomeone/nestjs-swagger-koa"],"tags_count":6,"template":false,"template_full_name":"SocketSomeone/nestjs-open-source-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SocketSomeone%2Fnestjs-swagger-koa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SocketSomeone%2Fnestjs-swagger-koa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SocketSomeone%2Fnestjs-swagger-koa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SocketSomeone%2Fnestjs-swagger-koa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SocketSomeone","download_url":"https://codeload.github.com/SocketSomeone/nestjs-swagger-koa/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501865,"owners_count":21114686,"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":["adapter","koa","nestjs","swagger"],"created_at":"2024-09-24T14:18:05.894Z","updated_at":"2025-04-12T01:21:41.093Z","avatar_url":"https://github.com/SocketSomeone.png","language":"TypeScript","funding_links":["https://github.com/sponsors/SocketSomeone"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://nestjs.com/\" target=\"blank\"\u003e\u003cimg src=\"https://nestjs.com/img/logo-small.svg\" width=\"120\" alt=\"Nest Logo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    A module for generating Swagger documentation for Koa applications in \u003ca href=\"https://nestjs.com/\" target=\"_blank\"\u003eNestJS\u003c/a\u003e.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href='https://img.shields.io/npm/v/nestjs-swagger-koa'\u003e\u003cimg src=\"https://img.shields.io/npm/v/nestjs-swagger-koa\" alt=\"NPM Version\" /\u003e\u003c/a\u003e\n    \u003ca href='https://img.shields.io/npm/l/nestjs-swagger-koa'\u003e\u003cimg src=\"https://img.shields.io/npm/l/nestjs-swagger-koa\" alt=\"NPM License\" /\u003e\u003c/a\u003e\n    \u003ca href='https://img.shields.io/npm/dm/nestjs-swagger-koa'\u003e\u003cimg src=\"https://img.shields.io/npm/dm/nestjs-swagger-koa\" alt=\"NPM Downloads\" /\u003e\u003c/a\u003e\n    \u003ca href='https://img.shields.io/github/last-commit/SocketSomeone/nestjs-swagger-koa'\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/SocketSomeone/nestjs-swagger-koa\" alt=\"Last commit\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n## About\n\nThis library is a NestJS module for generating Swagger documentation for Koa applications. Was created due this [issue](\nhttps://github.com/nestjs/swagger/pull/2351) in the official NestJS Swagger module. Also, this library is based on the official NestJS\nSwagger module and NestJS Koa adapter.\n\n## Installation\n\n```bash\n$ npm install --save nestjs-swagger-koa @nestjs/swagger nest-koa-adapter\n$ yarn add nestjs-swagger-koa @nestjs/swagger nest-koa-adapter\n$ pnpm add nestjs-swagger-koa @nestjs/swagger nest-koa-adapter\n```\n\n## Usage\n\nUsage was not changed from the official NestJS Swagger module. You can find the usage in the official\ndocumentation [here](https://docs.nestjs.com/openapi/introduction).\nAll you need to do is to replace the `@nestjs/swagger` module with `nestjs-swagger-koa` and import the `NestKoaAdapter`\nfrom `nest-koa-adapter`. Here is an example:\n\n```typescript\nimport { NestFactory } from '@nestjs/core';\nimport { DocumentBuilder } from '@nestjs/swagger';\nimport { AppModule } from './app.module';\nimport { KoaSwaggerModule } from 'nestjs-swagger-koa';\n\nasync function bootstrap() {\n    const app = await NestFactory.create(AppModule);\n\n    const config = new DocumentBuilder()\n        .setTitle('Cats example')\n        .setDescription('The cats API description')\n        .setVersion('1.0')\n        .addTag('cats')\n        .build();\n    const document = KoaSwaggerModule.createDocument(app, config);\n    KoaSwaggerModule.setup('api', app, document);\n\n    await app.listen(3000);\n}\n\nbootstrap();\n```\n\n## Stay in touch\n\n* Author - [Alexey Filippov](https://t.me/socketsomeone)\n* Twitter - [@SocketSomeone](https://twitter.com/SocketSomeone)\n\n## License\n\n[MIT](https://github.com/SocketSomeone/nestjs-swagger-koa/blob/master/LICENSE) © [Alexey Filippov](https://github.com/SocketSomeone)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsocketsomeone%2Fnestjs-swagger-koa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsocketsomeone%2Fnestjs-swagger-koa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsocketsomeone%2Fnestjs-swagger-koa/lists"}