版本環境
java:jdk-14.0.1
springboot:v2.3.4.RELEASE
gradle:gradle-6.7-rc-4
springfox(swagger):version: '3.0.0'
swagger-bootstrap-ui:version: '1.9.6'
IntelliJ IDEA:2020.1.2
swagger的配置
前後端分離的項目，接口文檔的存在十分重要。與手動編寫接口文檔不同，swagger是一個自動生成接口文檔的工具，在需求不斷變更的開發環境下，手動編寫文檔的效率實在太低。與新版的swagger3相比swagger2配置更少，使用更加友善。
一、build.gradle檔案中引入Swagger3依賴
//swagger3依賴 本次使用的是最新版的Swagger3，swagger已整合到springfox中去，在依賴引入時更友善
compile group: 'com.github.xiaoymin', name: 'swagger-bootstrap-ui', version: '1.9.6'
//swagger-bootstrap-ui依賴 引入此依賴可以試swagger節目更美觀且使用友善
compile group: 'com.github.xiaoymin', name: 'swagger-bootstrap-ui', version: '1.9.6'
二、Application上面加入@EnableOpenApi注解
package com.insentek.gradlespringboot;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.oas.annotations.EnableOpenApi;
/**
* @author lizechen
*/
@SpringBootApplication
@EnableOpenApi
public class GradleSpringBootApplication {
public static void main(String[] args) {
SpringApplication.run(GradleSpringBootApplication.class, args);
}
}
三、Swagger3Config的配置
package com.insentek.gradlespringboot.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.SecurityScheme;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import java.util.Collections;
import java.util.List;
/**
* @author zechen.li
* @since 2020/10/12
*/
@Configuration
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.build()
.securitySchemes(security());
}
private List<SecurityScheme> security() {
ApiKey apiKey = new ApiKey("Authorization", "Authorization", "header");
return Collections.singletonList(apiKey);
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("zechen.li TestDemo")
.description("gradle springboot swagger")
.version("1.0")
.build();
}
}
四、swagger-bootstrap-ui的配置
package com.insentek.gradlespringboot.config;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.spring.web.SpringfoxWebMvcConfiguration;
/**
* @author zechen.li
* @since 2020/10/12
*/
@SpringBootApplication
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
注解使用說明
@Api：用在請求的類上，表示對類的說明
tags="說明該類的作用，可以在UI界面上看到的注解"
value="該參數沒什麼意義，在UI界面上也看到，是以不需要配置"
@ApiOperation：用在請求的方法上，說明方法的用途、作用
value="說明方法的用途、作用"
notes="方法的備注說明"
@ApiImplicitParams：用在請求的方法上，表示一組參數說明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個請求參數的各個方面
name：參數名
value：參數的漢字說明、解釋
required：參數是否必須傳
paramType：參數放在哪個地方
· header --> 請求參數的擷取：@RequestHeader
· query --> 請求參數的擷取：@RequestParam
· path（用于restful接口）--> 請求參數的擷取：@PathVariable
· body（不常用）
· form（不常用）
dataType：參數類型，預設String，其它值dataType="Integer"
defaultValue：參數的預設值
@ApiResponses：用在請求的方法上，表示一組響應
@ApiResponse：用在@ApiResponses中，一般用于表達一個錯誤的響應資訊
code：數字，例如400
message：資訊，例如"請求參數沒填好"
response：抛出異常的類
@ApiModel：用于響應類上，表示一個傳回響應資料的資訊
（這種一般用在post建立的時候，使用@RequestBody這樣的場景，
請求參數無法使用@ApiImplicitParam注解進行描述的時候）
@ApiModelProperty：用在屬性上，描述響應類的屬性
使用執行個體
controller層
package com.insentek.gradlespringboot.controller;
import com.insentek.gradlespringboot.domain.User;
import com.insentek.gradlespringboot.service.LoginService;
import com.insentek.gradlespringboot.service.impl.LoginServiceImpl;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* @author zechen.li
* @since 2020/10/13
*/
@Api(value = "api/v1/dev/login")
@RestController
@RequestMapping(value ="api/v1/dev/login")
public class LoginController {
@Autowired
LoginService service;
@ApiOperation(value = "登入", notes = "使用使用者名密碼登入,傳回實體即為登入成功，未傳回實體即登入失敗")
@ApiImplicitParams({
@ApiImplicitParam(name = "name", value = "使用者名", dataType = "string", paramType = "query", required = true),
@ApiImplicitParam(name = "pass", value = "密碼", dataType = "string", paramType = "query", required = true),
})
@GetMapping(value = "", produces = MediaType.APPLICATION_JSON_VALUE)
public User selectVendorCount(@RequestParam(value = "name", required = true) String name,@RequestParam(value = "pass", required = true) String pass) {
return service.check(name,pass);
}
}
domain層/model層
package com.insentek.gradlespringboot.domain;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
* @author zechen.li
* @since 2020/10/13
*/
@NoArgsConstructor
@Data
@ApiModel(value = "使用者實體", description = "使用者實體類")
public class User {
@ApiModelProperty(value = "使用者名")
private String name;
@ApiModelProperty(value = "使用者密碼")
private String pass;
}
接口文檔和測試界面
編譯運作後通路http://localhost:8080/doc.html
![Java小案例——随機數猜測随機數猜測[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)