1. 程式人生 > 遊戲攻略 >《原神攻略》退潮後寶箱收集線路

《原神攻略》退潮後寶箱收集線路

轉載出處: https://www.javaboy.org/2019/0416/springboot-swagger.html

前後端分離後,維護介面文件基本上是必不可少的工作。一個理想的狀態是設計好後,介面文件發給前端和後端,大夥按照既定的規則各自開發,開發好了對接上了就可以上線了。當然這是一種非常理想的狀態,實際開發中卻很少遇到這樣的情況,介面總是在不斷的變化之中,有變化就要去維護,做過的小夥伴都知道這件事有多麼頭大!還好,有一些工具可以減輕我們的工作量,Swagger2就是其中之一,至於其他類似功能但是卻收費的軟體,這裡就不做過多介紹了。本文主要和大夥來聊下在Spring Boot中如何整合Swagger2。

工程建立

當然,首先是建立一個Spring Boot專案,加入web依賴,建立成功後,加入兩個Swagger2相關的依賴,完整的依賴如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId
>
io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency
>

Swagger2配置

Swagger2的配置也是比較容易的,在專案建立成功之後,只需要開發者自己提供一個Docket的Bean即可,如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.pathMapping("/")
.select()
.apis(RequestHandlerSelectors.basePackage("com.nvn.controller"))
.paths(PathSelectors.any())
.build().apiInfo(new ApiInfoBuilder()
.title("SpringBoot整合Swagger")
.description("SpringBoot整合Swagger,詳細資訊......")
.version("9.0")
.contact(new Contact("啊啊啊啊","blog.csdn.net","[email protected]"))
.license("The Apache License")
.licenseUrl("http://www.baidu.com")
.build());
}
}

這裡提供一個配置類,首先通過@EnableSwagger2註解啟用Swagger2,然後配置一個Docket Bean,這個Bean中,配置對映路徑和要掃描的介面的位置,在apiInfo中,主要配置一下Swagger2文件網站的資訊,例如網站的title,網站的描述,聯絡人的資訊,使用的協議等等。

如此,Swagger2就算配置成功了,非常方便。

此時啟動專案,輸入http://localhost:8080/swagger-ui.html,能夠看到如下頁面,說明已經配置成功了:

建立介面

接下來就是建立介面了,Swagger2相關的註解其實並不多,而且很容易懂,下面我來分別向小夥伴們舉例說明:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@RestController
@Api(tags = "使用者管理相關介面")
@RequestMapping("/user")
public class UserController {

@PostMapping("/")
@ApiOperation("新增使用者的介面")
@ApiImplicitParams({
@ApiImplicitParam(name = "username", value = "使用者名稱", defaultValue = "李四"),
@ApiImplicitParam(name = "address", value = "使用者地址", defaultValue = "深圳", required = true)
}
)
public RespBean addUser(String username, @RequestParam(required = true) String address) {
return new RespBean();
}

@GetMapping("/")
@ApiOperation("根據id查詢使用者的介面")
@ApiImplicitParam(name = "id", value = "使用者id", defaultValue = "99", required = true)
public User getUserById(@PathVariable Integer id) {
User user = new User();
user.setId(id);
return user;
}
@PutMapping("/{id}")
@ApiOperation("根據id更新使用者的介面")
public User updateUserById(@RequestBody User user) {
return user;
}
}

這裡邊涉及到多個API,我來向小夥伴們分別說明:

  1. @Api註解可以用來標記當前Controller的功能。
  2. @ApiOperation註解用來標記一個方法的作用。
  3. @ApiImplicitParam註解用來描述一個引數,可以配置引數的中文含義,也可以給引數設定預設值,這樣在介面測試的時候可以避免手動輸入。
  4. 如果有多個引數,則需要使用多個@ApiImplicitParam註解來描述,多個@ApiImplicitParam註解需要放在一個@ApiImplicitParams註解中。
  5. 需要注意的是,@ApiImplicitParam註解中雖然可以指定引數是必填的,但是卻不能代替@RequestParam(required = true),前者的必填只是在Swagger2框架內必填,拋棄了Swagger2,這個限制就沒用了,所以假如開發者需要指定一個引數必填,@RequestParam(required = true)註解還是不能省略。
  6. 如果引數是一個物件(例如上文的更新介面),對於引數的描述也可以放在實體類中。例如下面一段程式碼:
1
2
3
4
5
6
7
8
9
10
@ApiModel
public class User {
@ApiModelProperty(value = "使用者id")
private Integer id;
@ApiModelProperty(value = "使用者名稱")
private String username;
@ApiModelProperty(value = "使用者地址")
private String address;
//getter/setter
}

好了,經過如上配置之後,接下來,重新整理剛剛開啟的頁面,可以看到如下效果:

可以看到,所有的介面這裡都列出來了,包括介面請求方式,介面地址以及介面的名字等,點開一個介面,可以看到如下資訊:

可以看到,介面的引數,引數要求,引數預設值等等統統都展示出來了,引數型別下的query表示引數以key/value的形式傳遞,點選右上角的Try it out,就可以進行介面測試:

點選Execute按鈕,表示傳送請求進行測試。測試結果會展示在下面的Response中。

小夥伴們注意,引數型別下面的query表示引數以key/value的形式傳遞,這裡的值也可能是body,body表示引數以請求體的方式傳遞,例如上文的更新介面,如下:

當然還有一種可能就是這裡的引數為path,表示引數放在路徑中傳遞,例如根據id查詢使用者的介面:

當然,除了這些之外,還有一些響應值的註解,都比較簡單,小夥伴可以自己摸索下。

在Security中的配置

如果我們的Spring Boot專案中集成了Spring Security,那麼如果不做額外配置,Swagger2文件可能會被攔截,此時只需要在Spring Security的配置類中重寫configure方法,新增如下過濾即可:

1
2
3
4
5
6
7
@Override
public void configure(WebSecurity web) throws Exception {
web.ignoring()
.antMatchers("/swagger-ui.html")
.antMatchers("/v2/**")
.antMatchers("/swagger-resources/**");
}