{"_id":"@bvhoach2393/nest-swagger","_rev":"12-1d814de2506f0b1ab717ded1ea2d3c99","name":"@bvhoach2393/nest-swagger","dist-tags":{"latest":"1.0.11"},"versions":{"1.0.4":{"name":"@bvhoach2393/nest-swagger","version":"1.0.4","keywords":["nestjs","swagger","openapi","documentation","api","typescript"],"author":{"name":"bvhoach2393","email":"bvhoach2393@example.com"},"license":"MIT","_id":"@bvhoach2393/nest-swagger@1.0.4","maintainers":[{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"}],"homepage":"https://github.com/bvhoach2393/nest-swagger#readme","bugs":{"url":"https://github.com/bvhoach2393/nest-swagger/issues"},"dist":{"shasum":"b8b4feb1db95aca19dc92c720a435f5c9c1e059d","tarball":"https://registry.npmjs.org/@bvhoach2393/nest-swagger/-/nest-swagger-1.0.4.tgz","fileCount":13,"integrity":"sha512-R/0BTmrXkwy15HCU7GUfLNY6ElO2zkYowuS9DVq0BwKFI6uN70OVmuooHON9PzQsvtqgH4QDwgOrPW21DreHlQ==","signatures":[{"sig":"MEYCIQDGrBf7Bzn6sQpfWEby8FTTe+TFdeiQyn54H9Hs9OifrQIhAKsgqg0X9irxe0qA1IicFr1f0aVctDS6oHMUB6wnsecc","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":149494},"main":"index.js","types":"index.d.ts","engines":{"npm":">=7.0.0","node":">=16.0.0"},"gitHead":"bbd5fac63937cdd316d59006e2eb8670d5eafad0","scripts":{},"_npmUser":{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"},"repository":{"url":"git+https://github.com/bvhoach2393/nest-swagger.git","type":"git"},"_npmVersion":"11.4.2","description":"A NestJS library for easy Swagger/OpenAPI documentation setup","directories":{},"_nodeVersion":"24.2.0","_hasShrinkwrap":false,"peerDependencies":{"@nestjs/core":"^10.0.0 || ^11.0.0","@nestjs/common":"^10.0.0 || ^11.0.0","@nestjs/config":"^3.0.0","@nestjs/swagger":"^8.0.0","reflect-metadata":"^0.1.13 || ^0.2.0","swagger-ui-express":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nest-swagger_1.0.4_1752688065429_0.9197575658231418","host":"s3://npm-registry-packages-npm-production"}},"1.0.7":{"name":"@bvhoach2393/nest-swagger","version":"1.0.7","keywords":["nestjs","swagger","openapi","documentation","api","typescript"],"author":{"name":"bvhoach2393","email":"bvhoach2393@example.com"},"license":"MIT","_id":"@bvhoach2393/nest-swagger@1.0.7","maintainers":[{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"}],"homepage":"https://github.com/bvhoach2393/nest-swagger#readme","bugs":{"url":"https://github.com/bvhoach2393/nest-swagger/issues"},"dist":{"shasum":"06af88022832236bdadaf9d7d4919a3f55ea2da2","tarball":"https://registry.npmjs.org/@bvhoach2393/nest-swagger/-/nest-swagger-1.0.7.tgz","fileCount":13,"integrity":"sha512-Iml2exCKe9ZjT8mwXoxq4Qap0LZGKSaN9OHkJaoWNhbUe5dlCsXul0ZNcztdG/A5ajdeQN6UlcEjiOGvH3xUWw==","signatures":[{"sig":"MEUCIFCOQv7TxbDpIsc3iqnnGG4pCBHFdVPxLrAPxXQuMawdAiEAiIDupMn8kBnhuVEp6UN8FAgjTkCTY0tIr6JAvlgmsLo=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":149686},"main":"index.js","types":"index.d.ts","engines":{"npm":">=7.0.0","node":">=16.0.0"},"gitHead":"bbd5fac63937cdd316d59006e2eb8670d5eafad0","scripts":{},"_npmUser":{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"},"repository":{"url":"git+https://github.com/bvhoach2393/nest-swagger.git","type":"git"},"_npmVersion":"11.4.2","description":"A NestJS library for easy Swagger/OpenAPI documentation setup","directories":{},"_nodeVersion":"24.2.0","_hasShrinkwrap":false,"peerDependencies":{"@nestjs/core":"^10.0.0 || ^11.0.0","@nestjs/common":"^10.0.0 || ^11.0.0","@nestjs/config":"^3.0.0","@nestjs/swagger":"^8.0.0","reflect-metadata":"^0.1.13 || ^0.2.0","swagger-ui-express":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nest-swagger_1.0.7_1752688700152_0.3937084935059525","host":"s3://npm-registry-packages-npm-production"}},"1.0.8":{"name":"@bvhoach2393/nest-swagger","version":"1.0.8","keywords":["nestjs","swagger","openapi","documentation","api","typescript"],"author":{"name":"bvhoach2393","email":"bvhoach2393@example.com"},"license":"MIT","_id":"@bvhoach2393/nest-swagger@1.0.8","maintainers":[{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"}],"homepage":"https://github.com/bvhoach2393/nest-swagger#readme","bugs":{"url":"https://github.com/bvhoach2393/nest-swagger/issues"},"dist":{"shasum":"49308a2b93ab9e6179da1b3b59a4453f347671ea","tarball":"https://registry.npmjs.org/@bvhoach2393/nest-swagger/-/nest-swagger-1.0.8.tgz","fileCount":13,"integrity":"sha512-yzDdHKQsnUgYhEt5WnYC9wLJNAPVQFaT9v3Kpa+bzb0b3QYgz4WLjIpCkiKd50wp9W83Kct9QE7E9TeUo6hjsQ==","signatures":[{"sig":"MEQCIA5mVXHLA8qPmJm3e7L9MoQDsAWXfDHaD0iKWgVSC9jjAiAkZvWc9DUx4dEz8Ymh346yUXOnfv8duo51yIskL3QyAw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":149750},"main":"index.js","types":"index.d.ts","engines":{"npm":">=7.0.0","node":">=16.0.0"},"gitHead":"bbd5fac63937cdd316d59006e2eb8670d5eafad0","scripts":{},"_npmUser":{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"},"repository":{"url":"git+https://github.com/bvhoach2393/nest-swagger.git","type":"git"},"_npmVersion":"11.4.2","description":"A NestJS library for easy Swagger/OpenAPI documentation setup","directories":{},"_nodeVersion":"24.2.0","_hasShrinkwrap":false,"peerDependencies":{"@nestjs/core":"^10.0.0 || ^11.0.0","@nestjs/common":"^10.0.0 || ^11.0.0","@nestjs/config":"^3.0.0","@nestjs/swagger":"^8.0.0","reflect-metadata":"^0.1.13 || ^0.2.0","swagger-ui-express":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nest-swagger_1.0.8_1752688869208_0.695909370768558","host":"s3://npm-registry-packages-npm-production"}},"1.0.9":{"name":"@bvhoach2393/nest-swagger","version":"1.0.9","keywords":["nestjs","swagger","openapi","documentation","api","typescript"],"author":{"name":"bvhoach2393","email":"bvhoach2393@example.com"},"license":"MIT","_id":"@bvhoach2393/nest-swagger@1.0.9","maintainers":[{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"}],"homepage":"https://github.com/bvhoach2393/nest-swagger#readme","bugs":{"url":"https://github.com/bvhoach2393/nest-swagger/issues"},"dist":{"shasum":"5c236b6a7f90019935f0d7cb2ec0c43341ed81e1","tarball":"https://registry.npmjs.org/@bvhoach2393/nest-swagger/-/nest-swagger-1.0.9.tgz","fileCount":13,"integrity":"sha512-WZJp5IphxoBhpKa2wzxHJzjg04TkwXIhl79yzqnCf7C5zcgFdGORK5Yyu60IDBAh9pUgY1aH16P5xVmvyYlXMQ==","signatures":[{"sig":"MEUCIQC4tQfSg5nOdwyC7tnGi7/72WbY1AVeN79asPFR5iqIlwIgEYQnvl8/78qW9TnVRfrUX6VV60BrMEXuqylF5L9bhUA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":149814},"main":"index.js","types":"index.d.ts","engines":{"npm":">=7.0.0","node":">=16.0.0"},"gitHead":"bbd5fac63937cdd316d59006e2eb8670d5eafad0","scripts":{},"_npmUser":{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"},"repository":{"url":"git+https://github.com/bvhoach2393/nest-swagger.git","type":"git"},"_npmVersion":"11.4.2","description":"A NestJS library for easy Swagger/OpenAPI documentation setup","directories":{},"_nodeVersion":"24.2.0","_hasShrinkwrap":false,"peerDependencies":{"@nestjs/core":"^10.0.0 || ^11.0.0","@nestjs/common":"^10.0.0 || ^11.0.0","@nestjs/config":"^3.0.0","@nestjs/swagger":"^8.0.0","reflect-metadata":"^0.1.13 || ^0.2.0","swagger-ui-express":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nest-swagger_1.0.9_1752724334613_0.6598273594667192","host":"s3://npm-registry-packages-npm-production"}},"1.0.10":{"name":"@bvhoach2393/nest-swagger","version":"1.0.10","keywords":["nestjs","swagger","openapi","documentation","api","typescript"],"author":{"name":"bvhoach2393","email":"bvhoach2393@example.com"},"license":"MIT","_id":"@bvhoach2393/nest-swagger@1.0.10","maintainers":[{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"}],"homepage":"https://github.com/bvhoach2393/nest-swagger#readme","bugs":{"url":"https://github.com/bvhoach2393/nest-swagger/issues"},"dist":{"shasum":"425fc2357ea1df9747f22fa468050ba08bd19c45","tarball":"https://registry.npmjs.org/@bvhoach2393/nest-swagger/-/nest-swagger-1.0.10.tgz","fileCount":13,"integrity":"sha512-brsATY+h0fuAcRsI9MPs2liM/Q5RXV+pnJ7FUNKciIK8AnwUijZ97sW9n6CQzBCABxns21CRpY9v+73KtoDiUw==","signatures":[{"sig":"MEYCIQDIqbAzxU2la79M8D+k/l8zTUqHSmefLnHvk8aYENyMwQIhAO9CYlKNxNAqQj2QA8xeqIGZWVVdMwFWAMCrcKLBe0Fh","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":149881},"main":"index.js","types":"index.d.ts","engines":{"npm":">=7.0.0","node":">=16.0.0"},"gitHead":"bbd5fac63937cdd316d59006e2eb8670d5eafad0","scripts":{},"_npmUser":{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"},"repository":{"url":"git+https://github.com/bvhoach2393/nest-swagger.git","type":"git"},"_npmVersion":"11.4.2","description":"A NestJS library for easy Swagger/OpenAPI documentation setup","directories":{},"_nodeVersion":"24.2.0","_hasShrinkwrap":false,"peerDependencies":{"@nestjs/core":"^10.0.0 || ^11.0.0","@nestjs/common":"^10.0.0 || ^11.0.0","@nestjs/config":"^3.0.0","@nestjs/swagger":"^8.0.0","reflect-metadata":"^0.1.13 || ^0.2.0","swagger-ui-express":"^5.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nest-swagger_1.0.10_1752724393968_0.17848668049670757","host":"s3://npm-registry-packages-npm-production"}},"1.0.11":{"name":"@bvhoach2393/nest-swagger","version":"1.0.11","description":"A NestJS library for easy Swagger/OpenAPI documentation setup","main":"index.js","types":"index.d.ts","scripts":{},"repository":{"type":"git","url":"git+https://github.com/bvhoach2393/nest-swagger.git"},"bugs":{"url":"https://github.com/bvhoach2393/nest-swagger/issues"},"homepage":"https://github.com/bvhoach2393/nest-swagger#readme","keywords":["nestjs","swagger","openapi","documentation","api","typescript"],"author":{"name":"bvhoach2393","email":"bvhoach2393@example.com"},"license":"MIT","engines":{"node":">=16.0.0","npm":">=7.0.0"},"peerDependencies":{"@nestjs/common":"^10.0.0 || ^11.0.0","@nestjs/core":"^10.0.0 || ^11.0.0","@nestjs/config":"^3.0.0","@nestjs/swagger":"^8.0.0","swagger-ui-express":"^5.0.0","reflect-metadata":"^0.1.13 || ^0.2.0"},"_id":"@bvhoach2393/nest-swagger@1.0.11","gitHead":"065cecfbb474f3784a447f0bb5a85bf938463497","_nodeVersion":"24.5.0","_npmVersion":"11.5.1","dist":{"integrity":"sha512-IoFcd+3Sx4lO/yLOcs6eFNxCIL1N6kyHSJ4L6zWJtH49JLT1bKWNdEsBzvc4JtTz0hsV+F29Ca5CQx+fb4oenA==","shasum":"0da70be00bae852a7fe66747f649e6925adec4e3","tarball":"https://registry.npmjs.org/@bvhoach2393/nest-swagger/-/nest-swagger-1.0.11.tgz","fileCount":13,"unpackedSize":191386,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIDHaVE2EzBRii+a3DxtxvaBzFrqe6+cjnA4QPqH4dEemAiEA39zUB9itgiFIBXA5MRN/+J2k/akJMQUtKR0cLvPKUNU="}]},"_npmUser":{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"},"directories":{},"maintainers":[{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/nest-swagger_1.0.11_1754626555456_0.05161568298992658"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-16T17:47:45.343Z","modified":"2025-08-08T04:15:55.875Z","1.0.0":"2025-07-16T16:03:58.060Z","1.0.1":"2025-07-16T16:05:29.057Z","1.0.3":"2025-07-16T17:17:46.492Z","1.0.4":"2025-07-16T17:47:45.593Z","1.0.7":"2025-07-16T17:58:20.367Z","1.0.8":"2025-07-16T18:01:09.407Z","1.0.9":"2025-07-17T03:52:14.806Z","1.0.10":"2025-07-17T03:53:14.132Z","1.0.11":"2025-08-08T04:15:55.688Z"},"bugs":{"url":"https://github.com/bvhoach2393/nest-swagger/issues"},"author":{"name":"bvhoach2393","email":"bvhoach2393@example.com"},"license":"MIT","homepage":"https://github.com/bvhoach2393/nest-swagger#readme","keywords":["nestjs","swagger","openapi","documentation","api","typescript"],"repository":{"type":"git","url":"git+https://github.com/bvhoach2393/nest-swagger.git"},"description":"A NestJS library for easy Swagger/OpenAPI documentation setup","maintainers":[{"name":"bvhoach2393","email":"bvhoach2393@gmail.com"}],"readme":"# @bvhoach2393/nest-swagger\n\nA NestJS library for easy Swagger/OpenAPI documentation setup with environment variable configuration support.\n\n## Description\n\nThis library provides a simple and flexible way to configure Swagger documentation for NestJS applications. It supports environment variable configuration and includes both basic and authentication-enabled Swagger setups.\n\n## Features\n\n- 🚀 Easy Swagger setup for NestJS applications\n- 🔧 Environment variable configuration\n- 🔐 Support for authentication in Swagger documentation\n- ⚠️ Automatic warnings for missing environment variables\n- 📝 TypeScript support with full type definitions\n- 🧪 Comprehensive unit tests\n\n## Installation\n\n### Install the library\n\n```bash\nnpm install @bvhoach2393/nest-swagger\n```\n\n### Install peer dependencies\n\n```bash\nnpm install @nestjs/swagger swagger-ui-express @nestjs/config\n```\n\n## Environment Variables\n\nThe library reads the following environment variables:\n\n- `SWAGGER_TITLE` - Title for your API documentation\n- `SWAGGER_DESCRIPTION` - Description for your API documentation  \n- `SWAGGER_VERSION` - Version of your API\n- `SWAGGER_PATH` - Path where Swagger UI will be available (e.g., 'api-docs')\n- `SWAGGER_API_DOC_PATH` - Path for JSON documentation endpoint\n- `SWAGGER_TAG` - Default tag for your API endpoints\n\n### Example .env file\n\n```env\nSWAGGER_TITLE=My Awesome API\nSWAGGER_DESCRIPTION=This is an awesome API for managing resources\nSWAGGER_VERSION=1.0.0\nSWAGGER_PATH=api-docs\nSWAGGER_API_DOC_PATH=api-json\nSWAGGER_TAG=api\n```\n\n## Usage\n\n### 1. Import the module in your app module\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { ConfigModule } from '@nestjs/config';\nimport { NestSwaggerModule } from '@bvhoach2393/nest-swagger';\n\n@Module({\n  imports: [\n    ConfigModule.forRoot({\n      isGlobal: true,\n    }),\n    NestSwaggerModule,\n    // ... other modules\n  ],\n})\nexport class AppModule {}\n```\n\n### 2. Setup Swagger in your main.ts\n\n```typescript\nimport { NestFactory } from '@nestjs/core';\nimport { NestSwaggerService } from '@bvhoach2393/nest-swagger';\nimport { AppModule } from './app.module';\n\nasync function bootstrap() {\n  const app = await NestFactory.create(AppModule);\n  \n  // Get the swagger service\n  const swaggerService = app.get(NestSwaggerService);\n  \n  // Setup basic Swagger\n  swaggerService.setupSwagger(app);\n  \n  // Or setup Swagger with authentication\n  // swaggerService.setupSwaggerWithAuth(app);\n  \n  await app.listen(3000);\n}\nbootstrap();\n```\n\n### 3. Override configuration programmatically (optional)\n\n```typescript\nimport { SwaggerConfig } from '@bvhoach2393/nest-swagger';\n\nconst customConfig: SwaggerConfig = {\n  title: 'Custom API Title',\n  description: 'Custom API Description',\n  version: '2.0.0',\n  path: 'docs',\n  apiDocPath: 'api-json',\n  tag: 'custom'\n};\n\nswaggerService.setupSwagger(app, customConfig);\n```\n\n## Important Notes\n\n⚠️ **ConfigService is Optional**: The library can work without ConfigService. If ConfigService is not available, it will use default values or the configuration you provide manually.\n\n- **With ConfigService**: Reads environment variables automatically\n- **Without ConfigService**: Uses default values and shows a warning\n\n### Usage Options\n\n#### Option 1: With ConfigModule (Recommended)\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { ConfigModule } from '@nestjs/config';\nimport { NestSwaggerModule } from '@bvhoach2393/nest-swagger';\n\n@Module({\n  imports: [\n    ConfigModule.forRoot({\n      isGlobal: true,\n    }),\n    NestSwaggerModule,\n  ],\n})\nexport class AppModule {}\n```\n\n#### Option 2: Without ConfigModule\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { NestSwaggerModule } from '@bvhoach2393/nest-swagger';\n\n@Module({\n  imports: [NestSwaggerModule],\n})\nexport class AppModule {}\n```\n\nIn this case, you should provide configuration manually:\n\n```typescript\nconst customConfig: SwaggerConfig = {\n  title: 'My API',\n  description: 'API Description',\n  version: '1.0.0',\n  path: 'api-docs',\n  apiDocPath: 'api-json',\n  tag: 'api'\n};\n\nswaggerService.setupSwagger(app, customConfig);\n```\n\n## API Reference\n\n### NestSwaggerService\n\n#### Methods\n\n##### `setupSwagger(app: INestApplication, config?: SwaggerConfig): void`\n\nSets up basic Swagger documentation for your NestJS application.\n\n**Parameters:**\n- `app` - NestJS application instance\n- `config` - Optional configuration to override environment variables\n\n##### `setupSwaggerWithAuth(app: INestApplication, config?: SwaggerConfig): void`\n\nSets up Swagger documentation with Bearer authentication support.\n\n**Parameters:**\n- `app` - NestJS application instance  \n- `config` - Optional configuration to override environment variables\n\n### SwaggerConfig Interface\n\n```typescript\ninterface SwaggerConfig {\n  title?: string;           // API title\n  description?: string;     // API description\n  version?: string;         // API version\n  path?: string;           // Swagger UI path\n  apiDocPath?: string;     // JSON documentation path\n  tag?: string;            // Default API tag\n}\n```\n\n## Running Tests\n\n### Unit Tests\n\n```bash\nnpm run test\n```\n\n### Test Coverage\n\n```bash\nnpm run test:cov\n```\n\n### Test Watch Mode\n\n```bash\nnpm run test:watch\n```\n\n## Building the Library\n\n```bash\nnpm run build\n```\n\n## Publishing to NPM Registry\n\n### 1. Build the library\n\n```bash\nnpm run build\n```\n\n### 2. Test the package locally\n\n```bash\nnpm pack\n```\n\n### 3. Login to NPM (if not already logged in)\n\n```bash\nnpm login\n```\n\n### 4. Publish to NPM\n\n```bash\nnpm publish\n```\n\n### 5. Publish with specific tag (optional)\n\n```bash\nnpm publish --tag beta\n```\n\n## Development\n\n### Prerequisites\n\n- Node.js >= 16.0.0\n- npm >= 7.0.0\n\n### Setup Development Environment\n\n1. Clone the repository\n2. Install dependencies: `npm install`\n3. Run tests: `npm run test`\n4. Build the library: `npm run build`\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md) for a list of changes.\n\n## Support\n\nIf you encounter any issues or have questions, please file an issue on the [GitHub repository](https://github.com/bvhoach2393/nest-swagger/issues).\n\n## Author\n\n**bvhoach2393**\n- Email: bvhoach2393@example.com\n- GitHub: [@bvhoach2393](https://github.com/bvhoach2393)\n\n# 4. Copy files to dist and publish\nnpm run publish:lib:swagger\n```\n\n### Version Management\n\n```bash\n# Patch version (1.0.0 -> 1.0.1)\nnpm version patch\n\n# Minor version (1.0.0 -> 1.1.0)\nnpm version minor\n\n# Major version (1.0.0 -> 2.0.0)\nnpm version major\n```\n\n## Examples\n\n### Basic Example\n\n```typescript\n// main.ts\nimport { NestFactory } from '@nestjs/core';\nimport { AppModule } from './app.module';\nimport { NestSwaggerService } from '@bvhoach2393/nest-swagger';\n\nasync function bootstrap() {\n  const app = await NestFactory.create(AppModule);\n  \n  const swaggerService = new NestSwaggerService();\n  swaggerService.setupSwagger(app);\n  \n  await app.listen(3000);\n  console.log('API Documentation available at: http://localhost:3000/api');\n}\nbootstrap();\n```\n\n### Advanced Example with Authentication\n\n```typescript\n// main.ts\nimport { NestFactory } from '@nestjs/core';\nimport { AppModule } from './app.module';\nimport { NestSwaggerService } from '@bvhoach2393/nest-swagger';\n\nasync function bootstrap() {\n  const app = await NestFactory.create(AppModule);\n  \n  const swaggerService = new NestSwaggerService();\n  \n  swaggerService.setupSwaggerWithAuth(app, {\n    title: 'My Secure API',\n    description: 'API with Bearer Token and API Key authentication',\n    version: '2.0',\n    path: 'docs',\n    tag: 'secure-api'\n  });\n  \n  await app.listen(3000);\n  console.log('API Documentation available at: http://localhost:3000/docs');\n}\nbootstrap();\n```\n\n## Dependencies\n\n### Runtime Dependencies\n- `@nestjs/swagger`: ^8.0.0\n- `swagger-ui-express`: ^5.0.0\n\n### Peer Dependencies\n- `@nestjs/common`: ^10.0.0 || ^11.0.0\n- `@nestjs/core`: ^10.0.0 || ^11.0.0\n- `reflect-metadata`: ^0.1.13 || ^0.2.0\n\n## License\n\nMIT\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch: `git checkout -b feature/my-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin feature/my-feature`\n5. Submit a pull request\n\n## Support\n\nIf you encounter any issues or have questions, please file an issue on the [GitHub repository](https://github.com/bvhoach2393/nest-swagger/issues).\n","readmeFilename":"README.md"}