swagger 注释

①类名上用@Api(description = "能力相关API") 注解

@RestController
@RequestMapping("/api")
@Api(description = "能力相关API")
public class CompetencyClientResource 

②方法上用@ApiOperation("能力删除")注解(@ApiParam 是对competencyId的注释)

@ApiOperation("能力删除")
@PostMapping("/competency/delete/{competencyId}")
@Timed
public ResponseEntity<String> deleteCompetency(@ApiParam("能力ID") @PathVariable Long competencyId)

③在model上的注解用 @ApiModel

@ApiModel("检索条件DTO")
public class QuerySkillDTO implements Serializable {

    @ApiModelProperty("技能名称或编码")
    private String nameOrCode;

    @ApiModelProperty("技能类型")
    private String category;

    @ApiModelProperty("页数")
    private int page = 0;

    @ApiModelProperty("件数")
    private int size = 10;

swagger展示视图就不截图了,几个注解简单的用法,稍微记载一下,便于以后再用。


Swagger是一个用于生成、描述和可视化RESTful API的工具。通过在代码中使用Swagger注释,可以自动生成API文档的YAML文件。以下是如何使用Swagger注释生成YAML文件的步骤: 1. **在代码中添加Swagger注释**:在Java类和方法上添加Swagger注释,例如`@Api`, `@ApiOperation`, `@ApiParam`等。 2. **配置Swagger**:在项目的配置文件中配置Swagger,例如在`application.properties`或`application.yml`中添加Swagger的配置。 3. **生成YAML文件**:使用Swagger的工具或插件来生成YAML文件。常用的工具包括Swagger Codegen和Swagger UI。 以下是一个简单的示例: 假设我们有一个Spring Boot项目,并且我们想要为我们的RESTful API生成YAML文件。 1. **添加Swagger依赖**: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 2. **在代码中添加Swagger注释**: ```java import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import org.springframework.web.bind.annotation.*; @Api(tags = "用户管理") @RestController @RequestMapping("/users") public class UserController { @ApiOperation("获取用户列表") @GetMapping public List<User> getUsers() { // 方法实现 } @ApiOperation("创建用户") @PostMapping public User createUser(@RequestBody User user) { // 方法实现 } @ApiOperation("获取用户详情") @GetMapping("/{id}") public User getUserById(@PathVariable Long id) { // 方法实现 } } ``` 3. **配置Swagger**: ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @Configuration public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.OAS_30) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo")) .paths(PathSelectors.any()) .build(); } } ``` 4. **生成YAML文件**: 运行Spring Boot应用程序后,访问`http://localhost:8080/v3/api-docs`即可获取YAML格式的API文档。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值