Swagger 3主要注解有哪些
时间: 2024-04-19 16:23:34 浏览: 89
Swagger 3 是一种用于构建和描述 RESTful API 的工具,它使用注解来定义 API 的各个方面。以下是一些 Swagger 3 中常用的注解:
1. @OpenAPIDefinition:用于定义整个 API 的信息,如标题、版本号、许可证等。
2. @Info:用于定义 API 文档的基本信息,如标题、描述、联系人等。
3. @Server:用于定义服务器的信息,包括 URL 和描述。
4. @Paths:用于定义 API 的路径和操作,包含多个 @PathItem 注解。
5. @PathItem:用于定义单个路径的操作,如 GET、POST、PUT、DELETE 等。
6. @Operation:用于定义单个操作的信息,如概要、描述、参数等。
7. @Parameter:用于定义操作的参数,包括路径参数、查询参数、请求体等。
8. @RequestBody:用于定义请求体的内容和格式。
9. @ApiResponse:用于定义响应的信息,包括状态码、描述和响应模型。
10. @Schema:用于定义数据模型的结构和属性。
这些注解可以帮助开发者构建出清晰、可读性强的 API 文档,并且可以自动生成 API 文档页面。
相关问题
Swagger开发常用注解有哪些?都是什么含义?
Swagger开发常用注解有以下几个:
1. @Api:用于修饰整个类,表示该类是Swagger资源。
2. @ApiOperation:用于修饰方法,表示一个HTTP请求的操作。
3. @ApiParam:用于修饰方法参数,表示对参数的额外描述。
4. @ApiModel:用于修饰实体类,表示对实体类的额外描述。
5. @ApiModelProperty:用于修饰实体类属性,表示对实体类属性的额外描述。
6. @ApiIgnore:用于修饰类或方法,表示忽略该类或方法。
7. @ApiResponse:用于修饰方法返回值,表示对返回值的额外描述。
8. @ApiResponses:用于修饰方法,表示一组响应。
9. @ApiImplicitParam:用于修饰方法参数,表示一个请求参数。
10. @ApiImplicitParams:用于修饰方法,表示一组请求参数。
这些注解的含义和作用可以通过Swagger生成的API文档展示出来,方便了解API的使用。
swagger3常用注解
swagger3常用注解包括:
1. @OpenAPIDefinition:定义OpenAPI规范的注解。
2. @Tag:用于对API进行分组和标记的注解。
3. @Operation:用于对API操作进行描述的注解。
4. @Parameter:用于定义API的参数的注解。
5. @RequestBody:用于定义API请求的请求体的注解。
6. @ApiResponse:用于定义API响应的注解。
7. @ApiModel:用于定义数据模型的注解。
8. @ApiModelProperty:用于定义数据模型属性的注解。
9. @Schema:用于定义数据模型的注解。
10. @Hidden:用于隐藏API接口的注解。
阅读全文