天天看點

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具

以上僅了解就可以了。主要看下面:為符合RESTful規範,Spring Boot 使用下列對應注解。

SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具

例如:

1.傳統的 删除使用者 操作

get http://localhost/del?id=10

使用者通過get發送請求,傳過來一個使用者編号10,然後就把編号為10的使用者删除。

但是在RESTful下就不能這樣做。删除應該用delete,語句後面不要出現動詞

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

。這裡資源是使用者,可以設定一個user的路徑,後面傳一個10。

delete http://localhost/user/10

SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具

說明:

動态傳過來的參數要交{ },如果想拿路徑上的參數id,在下面一定要加@PathVariable注解,否則,拿不到id,隻能拿到?号之後的東西。

執行個體示範:

在controller包下建立一個UserController類

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

代碼如下:

package com.example.helloworld.controller;

import com.example.helloworld.entity.User;

import org.springframework.web.bind.annotation.*;

@RestController

public class UserController {

@GetMapping("/user/{id}")

public String getUserById(@PathVariable int id){

System.out.println(id);

return "根據ID擷取使用者資訊";

}

@PostMapping("/user")

public String save(User user){

return "添加使用者";

}

@PutMapping("/user")

public String update(User user){

return "更新資料";

}

@DeleteMapping("/user/{id}")

public String deleteById(@PathVariable int id){

System.out.println(id);

return "根據使用者ID删除使用者";

}

}

在浏覽器中輸入: http://localhost:8080/user/10 顯示下圖

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

在IDEA 中列印出

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

LoginInterceptor 是上節的攔截器,10是本次傳遞的參數

Swagger工具

對企業而言,不同子產品由不同人去開發。這些接口最終都要交給前端去調用。前端需要一個自動同步的文檔,知道有哪些接口,發生了哪些變化。用Swagger就可以動态生成文檔,也可以做接口調試。

SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具

具體操作:

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

首先需要在pom.xml中加入下列代碼:

<!-- 添加 swagger相關功能-->

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.9.2</version>

</dependency>

<!-- 添加 swagger-ui相關功能-->

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.9.2</version>

</dependency>

</dependencies>

注意一定要點右邊的更新

SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具

spring.mvc.pathmatch.matching-strategy=ant_path_matcher

添加 SwaggerConfig 類

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

代碼如下:

@Configuration //告訴Spring 容器,這個類是一個配置類

@EnableSwagger2 //啟動Swagger2 功能

public class SwaggerConfig {

/**

* 配置Swagger2相關的bean

*/

@Bean

public Docket createRestApi(){

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage("com"))

.paths(PathSelectors.any()).build();

}

/**

* 此處主要是API文檔頁面顯示資訊

*/

private ApiInfo apiInfo(){

return new ApiInfoBuilder()

.title("示範項目API")//标題

.description("示範項目")//描述

.version("1.0")//版本

.build();

}

}

SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具

項目中的4個控制器都被讀取了,展開控制器,可以看到裡面的方法,對前端來說就一目了然。前端發什麼請求可以得到什麼資料。

SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具

在控制器中加注解,可以在swagger中顯示出來。例如:

在UserController控制器中加入@ApiOperation("擷取使用者")注解

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

就可以在Swagger中顯示出來

SpringBoot + Vue(五)建構RESTful服務和Swagger工具

Swagger也可以做調試,類似Apipost的功能

SpringBoot + Vue(五)建構RESTful服務和Swagger工具
SpringBoot + Vue(五)建構RESTful服務和Swagger工具