springboot-swagger:配置實體類和註釋
阿新 • • 發佈:2022-03-10
1 配置實體類
1.1 建立pojo包,並在該包下編寫使用者實體類
src/main/java/com/lv/pojo/User.java
package com.lv.pojo;
public class User {
public String username;
public String password;
}
1.2 編寫HelloControlelr
在控制類中編寫一個請求,只要這個實體在請求的返回值上(即使是泛型),都能對映到實體項中
src/main/java/com/lv/controller/HelloController.java
package com.lv.controller; import com.lv.pojo.User; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class HelloController { @RequestMapping("/hello") public String hello(){ return "hello"; } //只要我們的介面中,返回值中存在實體類,他就會被掃描到Swagger中 @PostMapping(value = "/user") public User user(){ return new User(); } }
1.3 啟動程式測試
實體類顯示成功
2 swagger中的註釋
swagger的註釋都是通過添加註解的方式實現
2.1給使用者類添加註釋的註解
@ApiModel為類添加註釋
@ApiModelProperty為類屬性添加註釋
src/main/java/com/lv/pojo/User.java
package com.lv.pojo; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; //@Api(註釋) @ApiModel("使用者實體類") public class User { @ApiModelProperty("使用者名稱") public String username; @ApiModelProperty("密碼") public String password; }
2.2 啟動程式檢視註釋位置
2.3 給請求介面配置註釋的註解
@ApiOperation 為介面方法添加註釋
@ApiParam 為引數添加註釋
src/main/java/com/lv/controller/HelloController.java
@ApiOperation("hello控制類")
@GetMapping(value = "/hello2")
public String hello2(@ApiParam("使用者名稱") String username){
return "hello"+username;
}
2.4 重啟程式檢視註釋位置
2.5 Swagger註解簡單說明:
- Swagger的所有註解定義在io.swagger.annotations包下
- @Api(tags = "xxx模組說明") 作用在模組類上
- @ApiOperation("xxx介面說明") 作用在介面方法上
- @ApiModel("xxxPOJO說明") 作用在模型類上:如VO、BO
- @ApiModelProperty(value = "xxx屬性說明",hidden = true) 作用在類方法和屬性上,hidden設定為true可以隱藏該屬性
- @ApiParam("xxx引數說明") 作用在引數、方法和欄位上,類似@ApiModelProperty