|
2 | 2 |
|
3 | 3 | All of the available OpenAPI decorators have an `Api` prefix to distinguish them from the core decorators. Below is a full list of the exported decorators along with a designation of the level at which the decorator may be applied.
|
4 | 4 |
|
5 |
| -| | | |
6 |
| -| ------------------------ | ------------------- | |
7 |
| -| `@ApiOperation()` | Method | |
8 |
| -| `@ApiResponse()` | Method / Controller | |
9 |
| -| `@ApiProduces()` | Method / Controller | |
10 |
| -| `@ApiConsumes()` | Method / Controller | |
11 |
| -| `@ApiBearerAuth()` | Method / Controller | |
12 |
| -| `@ApiOAuth2()` | Method / Controller | |
13 |
| -| `@ApiBasicAuth()` | Method / Controller | |
14 |
| -| `@ApiSecurity()` | Method / Controller | |
15 |
| -| `@ApiExtraModels()` | Method / Controller | |
16 |
| -| `@ApiBody()` | Method | |
17 |
| -| `@ApiParam()` | Method | |
18 |
| -| `@ApiQuery()` | Method | |
19 |
| -| `@ApiHeader()` | Method / Controller | |
20 |
| -| `@ApiExcludeEndpoint()` | Method | |
21 |
| -| `@ApiTags()` | Method / Controller | |
22 |
| -| `@ApiProperty()` | Model | |
23 |
| -| `@ApiPropertyOptional()` | Model | |
24 |
| -| `@ApiHideProperty()` | Model | |
25 |
| -| `@ApiExtension()` | Method | |
| 5 | +| | | |
| 6 | +| ------------------------- | ------------------- | |
| 7 | +| `@ApiBasicAuth()` | Method / Controller | |
| 8 | +| `@ApiBearerAuth()` | Method / Controller | |
| 9 | +| `@ApiBody()` | Method | |
| 10 | +| `@ApiConsumes()` | Method / Controller | |
| 11 | +| `@ApiCookieAuth()` | Method / Controller | |
| 12 | +| `@ApiExcludeController()` | Controller | |
| 13 | +| `@ApiExcludeEndpoint()` | Method | |
| 14 | +| `@ApiExtension()` | Method | |
| 15 | +| `@ApiExtraModels()` | Method / Controller | |
| 16 | +| `@ApiHeader()` | Method / Controller | |
| 17 | +| `@ApiHideProperty()` | Model | |
| 18 | +| `@ApiOAuth2()` | Method / Controller | |
| 19 | +| `@ApiOperation()` | Method | |
| 20 | +| `@ApiParam()` | Method | |
| 21 | +| `@ApiProduces()` | Method / Controller | |
| 22 | +| `@ApiProperty()` | Model | |
| 23 | +| `@ApiPropertyOptional()` | Model | |
| 24 | +| `@ApiQuery()` | Method | |
| 25 | +| `@ApiResponse()` | Method / Controller | |
| 26 | +| `@ApiSecurity()` | Method / Controller | |
| 27 | +| `@ApiTags()` | Method / Controller | |
0 commit comments