{"id":17145121,"url":"https://github.com/apexcaptain/nestjs-swagger-hide-on-prod","last_synced_at":"2025-07-02T09:35:51.380Z","repository":{"id":103639286,"uuid":"528267736","full_name":"ApexCaptain/nestjs-swagger-hide-on-prod","owner":"ApexCaptain","description":null,"archived":false,"fork":false,"pushed_at":"2022-09-27T04:22:05.000Z","size":510,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-08T18:47:13.423Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ApexCaptain.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":"2022-08-24T04:42:26.000Z","updated_at":"2024-11-07T16:31:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"f8d5114c-9941-432c-8b7a-1bb3dd8a7003","html_url":"https://github.com/ApexCaptain/nestjs-swagger-hide-on-prod","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/ApexCaptain/nestjs-swagger-hide-on-prod","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApexCaptain%2Fnestjs-swagger-hide-on-prod","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApexCaptain%2Fnestjs-swagger-hide-on-prod/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApexCaptain%2Fnestjs-swagger-hide-on-prod/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApexCaptain%2Fnestjs-swagger-hide-on-prod/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ApexCaptain","download_url":"https://codeload.github.com/ApexCaptain/nestjs-swagger-hide-on-prod/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ApexCaptain%2Fnestjs-swagger-hide-on-prod/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263112363,"owners_count":23415590,"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":[],"created_at":"2024-10-14T21:04:37.708Z","updated_at":"2025-07-02T09:35:51.344Z","avatar_url":"https://github.com/ApexCaptain.png","language":"TypeScript","funding_links":[],"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\u003cp align=\"center\"\u003eA progressive \u003ca href=\"http://nodejs.org\" target=\"blank\"\u003eNode.js\u003c/a\u003e framework for building efficient and scalable server-side applications.\u003c/p\u003e\n\n# Nestjs Swagger Hide on Prod\n\n## Description\n\nExclude your nestjs controller or endpoint from swagger documentization on production env.\n\n## Installation\n\n```bash\n$ yarn add nestjs-swagger-hide-on-prod\n```\n\nor\n\n```bash\n$ npm i --save nestjs-swagger-hide-on-prod\n```\n\n## Getting Started\n\nIn default, when `NODE_ENV` is set to `PROD` or `PRODUCTION`, following decorators will exclude the whole controller or specific endpoint\n\n- @SwaggerHideControllerOnProd\n- @SwaggerHideEndpointOnProd\n\nTo exclude whole controller on prod :\n\n```typescript\n@Controller('foo')\n@ApiTags('Foo API')\n@SwaggerHideControllerOnProd() // Add this line to exclude FooController from swagger when process is on production environment\nexport class FooController {\n  constructor(private readonly fooService: FooService) {}\n  @Get(':fooId')\n  searchFoos(): Promise\u003cany[]\u003e {\n    return Promise.resolve([]);\n  }\n\n  @Post()\n  createFoo(): Promise\u003cany\u003e {\n    return Promise.resolve();\n  }\n}\n```\n\nTo Exclude specific endpoint only on prod :\n\n```typescript\n@Controller('foo')\n@ApiTags('Foo API')\nexport class FooController {\n  constructor(private readonly fooService: FooService) {}\n  @Get(':fooId')\n  searchFoos(): Promise\u003cany[]\u003e {\n    return Promise.resolve([]);\n  }\n\n  @Post()\n  @SwaggerHideEndpointOnProd() // Exclude POST /foo endpoint from swagger on prod env\n  createFoo(): Promise\u003cany\u003e {\n    return Promise.resolve();\n  }\n}\n```\n\nTo customize exclusion condition you can use\n\n- @SwaggerHideController\n- @SwaggerHideEndpoint\n\ninstead.\nInput parameter could be static `boolean` or a `function`, which returns a `boolean` value.\n\n```typescript\n@Controller('foo')\n@ApiTags('Foo API')\nexport class FooController {\n  constructor(private readonly fooService: FooService) {}\n\n  @Get(':fooId')\n  @ApiOperation({\n    summary: 'Search foos info',\n    description: 'This method is depreacted. Please, use GET \"v2\" instaed',\n  })\n  @SwaggerHideEndpoint(() =\u003e {\n    return moment(new Date()).isAfter(`2022-12-31`);\n    // After year 2022, this method would be excluded from swagger documentization\n  })\n  veryOldFooSearchApi(): Promise\u003cany[]\u003e {\n    return Promise.resolve([]);\n  }\n\n  @Get('v2/:fooId')\n  @ApiOperation({\n    summary: `Search foos info`,\n    description: `Get information matches id`,\n  })\n  brandNewFooSearchApi(): Promise\u003cany[]\u003e {\n    return Promise.resolve([]);\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapexcaptain%2Fnestjs-swagger-hide-on-prod","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapexcaptain%2Fnestjs-swagger-hide-on-prod","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapexcaptain%2Fnestjs-swagger-hide-on-prod/lists"}