![\"PRs](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\"){kind=icon}
\n \n \n ![\"Nest](\"https://raw.githubusercontent.com/nestjsx/crud/e9f8424c8d5bbec3b7d6f827abecaa07ced86091/img/nest-powered.svg?sanitize=true\")
\n \n ![\"MIT](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n\n\nš This is a [ReDoc](https://github.com/Redocly/redoc) powered frontend for your NestJS API spec.\n\n
\n\n## ā” Features\n\n- Customizable theme\n- It's almost a drop in replacement for you current swagger UI, you only need to import this package and modify any settings you may want to change (e.g: Page title, ReDoc options)\n\n## šæ Installation\n\nUsing npm: `npm i nestjs-redoc`\n\nUsing yarn: `yarn add nestjs-redoc`\n\n## ā How to use\n\nYou need to install the [Swagger Module](https://github.com/nestjs/swagger) first if you want to get definitions updated with your project.\n\nIn future versions you will be able to pass a URL parameter as document, but for the moment you need this document object from the swagger module\n\n```typescript\nconst options = new DocumentBuilder()\n .setTitle('Look, i have a title')\n .setDescription('A very nice description')\n .setBasePath('/api/v1')\n .build();\nconst document = SwaggerModule.createDocument(app, options);\n```\n\nThen add the following example code.\n\n**Note**: All properties are optional, if you don't specify a title we will fallback to the one you used in your DocumentBuilder instance.\n\n```typescript\nconst redocOptions: RedocOptions = {\n title: 'Hello Nest',\n logo: {\n url: 'https://redocly.github.io/redoc/petstore-logo.png',\n backgroundColor: '#F0F0F0',\n altText: 'PetStore logo'\n },\n sortPropsAlphabetically: true,\n hideDownloadButton: false,\n hideHostname: false,\n auth: {\n enabled: true,\n user: 'admin',\n password: '123'\n },\n tagGroups: [\n {\n name: 'Core resources',\n tags: ['cats'],\n },\n ],\n};\n// Instead of using SwaggerModule.setup() you call this module\nawait RedocModule.setup('/docs', app, document, redocOptions);\n```\n\n## Available options\n\n### Redoc Options\n\n| Option | Description | Type | Note |\n| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------ |\n| title | Web site title (e.g: ReDoc documentation) | string |\n| favicon | Web site favicon URL | string | Fallbacks to the document title if not set |\n| logo | Logo options | LogoOptions | See LogoOptions table |\n| theme | Theme options | ThemeOptions | See ThemeOptions info |\n| untrustedSpec | If set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS, by default is false | boolean |\n| supressWarnings | If set, warnings are not rendered at the top of documentation (they are still logged to the console) | boolean |\n| hideHostname | If set, the protocol and hostname won't be shown in the operation definition | boolean |\n| expandResponses | Specify which responses to expand by default by response codes, values should be passed as comma-separated list without spaces (e.g: 200, 201, \"all\") | string |\n| requiredPropsFirst | If set, show required properties first ordered in the same order as in required array | boolean |\n| sortPropsAlphabetically | If set, propeties will be sorted alphabetically | boolean |\n| showExtensions | If set the fields starting with \"x-\" will be shown, can be a boolean or a string with names of extensions to display | boolean |\n| noAutoAuth | If set, redoc won't inject authentication section automatically | boolean |\n| pathInMiddlePanel | If set, path link and HTTP verb will be shown in the middle panel instead of the right one | boolean |\n| hideLoading | If set, loading spinner animation won't be shown | boolean |\n| nativeScrollbars | If set, a native scrollbar will be used instead of perfect-scroll, this can improve performance of the frontend for big specs | boolean |\n| hideDownloadButton | This will hide the \"Download spec\" button, it only hides the button | boolean |\n| disableSearch | If set, the search bar will be disabled | boolean |\n| onlyRequiredInSamples | Shows only required fileds in request samples | boolean |\n| auth | Auth options | AuthOptions | See AuthOptions info |\n| AuthOptions info |\n| enabled | If enabled, a prompt will pop out asking for authentication details, default: `false` | boolean |\n| user | User name, default: `admin` | string |\n| password | User password, default: `123` | string |\n| tagGroups | Tag groups options | TagGroupOptions[] | See Tag Group options |\n| Tag Group options info |\n| name | Tag name | string |\n| tags | Tag collection | string[] |\n| redocVersion | Set an specific redoc version | string,number | By default it's \"latest\" |\n\n\n\n\n**Note**: If you want to change your ReDoc theme settings, take a look at the official ReDoc documentation: