Commit fe4840f

committed

docs(openapi): Add docs to throw different exceptions under the same http code

1 parent c6e212f commit fe4840fCopy full SHA for fe4840f

File tree

+21

-0

lines changed

+21

-0

lines changed

Lines changed: 21 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -298,3 +298,24 @@ pets: Pet[];`
`298`	`298`	> info Hint The `getSchemaPath()` function is imported from `@nestjs/swagger`.
`299`	`299`
`300`	`300`	Both `Cat` and `Dog` must be defined as extra models using the `@ApiExtraModels()` decorator (at the class-level).
	`301`	`+`
	`302`	`+#### Multiple responses in controller`
	`303`	`+`
	`304`	+In case your app returns different exceptions with under the same HTTP status code, you might use `@ApiExtraModels()` in this way:
	`305`	`+`
	`306`	+```typescript
	`307`	`+@Injectable()`
	`308`	`+export class CatController {`
	`309`	`+@ApiExtraModels(BadAppCodeException, BadEmailException)`
	`310`	`+@ApiBadRequestResponse({`
	`311`	`+ schema: {`
	`312`	`+ oneOf: refs(BadAppCodeException, BadEmailException),`
	`313`	`+ },`
	`314`	`+})`
	`315`	`+multipleErrorsResponse() { ... }`
	`316`	`+}`
	`317`	+```
	`318`	`+`
	`319`	+First, you tell swagger that `BadAppCodeException` and `BadEmailException` are models it needs to look at. After that, you use `oneOf` and `refs` to set the different exceptions your API might throw.
	`320`	`+`
	`321`	+> info Hint The `refs()` function is imported from `@nestjs/swagger`.

Comments

(0)