@@ -91,25 +91,25 @@ export class Server {}
9191
9292Some options are available to configure Swagger-ui, Ts.ED and the default spec information.
9393
94- | Key | Example | Description |
95- | -------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
96- | path | ` /api-doc ` | The url subpath to access to the documentation. |
97- | specVersion | ` 2.0 ` , ` 3.0.1 ` | The OpenSpec version. |
98- | fileName | ` swagger.json ` | Swagger file name. By default swagger.json. |
99- | doc | ` hidden-doc ` | The documentation key used by ` @Docs ` decorator to create several swagger documentations. |
100- | viewPath | ` ${rootDir}/../views/swagger.ejs ` or ` false ` | The path to the ejs template. Set false to disabled swagger-ui. |
101- | cssPath | ` ${rootDir}/spec/style.css ` | The path to the CSS file. |
102- | jsPath | ` ${rootDir}/spec/main.js ` | The path to the JS file. |
103- | viewPath | ` ${rootDir}/views/swagger.ejs ` | The path to the ejs file to create html page. |
104- | showExplorer | ` true ` | Display the search field in the navbar. |
105- | spec | ` {swagger: "2.0"} ` | The default information spec. |
106- | specPath | ` ${rootDir}/spec/swagger.base.json ` | Load the base spec documentation from the specified path. |
107- | outFile | ` ${rootDir}/spec/swagger.json ` | Write the ` swagger.json ` spec documentation on the specified path. |
108- | hidden | ` true ` | Hide the documentation in the dropdown explorer list. |
94+ | Key | Example | Description |
95+ | -------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
96+ | path | ` /api-doc ` | The url subpath to access to the documentation. |
97+ | specVersion | ` 2.0 ` , ` 3.0.1 ` | The OpenSpec version. |
98+ | fileName | ` swagger.json ` | Swagger file name. By default swagger.json. |
99+ | doc | ` hidden-doc ` | The documentation key used by ` @Docs ` decorator to create several swagger documentations. |
100+ | viewPath | ` ${rootDir}/../views/swagger.ejs ` or ` false ` | The path to the ejs template. Set false to disabled swagger-ui. |
101+ | cssPath | ` ${rootDir}/spec/style.css ` | The path to the CSS file. |
102+ | jsPath | ` ${rootDir}/spec/main.js ` | The path to the JS file. |
103+ | viewPath | ` ${rootDir}/views/swagger.ejs ` | The path to the ejs file to create html page. |
104+ | showExplorer | ` true ` | Display the search field in the navbar. |
105+ | spec | ` {swagger: "2.0"} ` | The default information spec. |
106+ | specPath | ` ${rootDir}/spec/swagger.base.json ` | Load the base spec documentation from the specified path. |
107+ | outFile | ` ${rootDir}/spec/swagger.json ` | Write the ` swagger.json ` spec documentation on the specified path. |
108+ | hidden | ` true ` | Hide the documentation in the dropdown explorer list. |
109109| options | Swagger-UI options | SwaggerUI options. See (https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md) |
110- | operationIdFormatter | ` (name: string, propertyKey: string, path: string) => string ` | A function to generate the operationId. |
111- | operationIdPattern | ` %c_%m ` | A pattern to generate the operationId. Format of operationId field (%c: class name, %m: method name). |
112- | pathPatterns | ` [] ` | Include only controllers whose paths match the pattern list provided. |
110+ | operationIdFormatter | ` (name: string, propertyKey: string, path: string) => string ` | A function to generate the operationId. |
111+ | operationIdPattern | ` %c_%m ` | A pattern to generate the operationId. Format of operationId field (%c: class name, %m: method name). |
112+ | pathPatterns | ` [] ` | Include only controllers whose paths match the pattern list provided. |
113113
114114### Multi documentations
115115
0 commit comments