pomファイルリファレンス
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.6</version>
</dependency>
コードクラス
package com.imooc.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class Swagger2 {
// http://localhost:8088/swagger-ui.html 原路径
// http://localhost:8088/doc.html 原路径
// 配置swagger2核心配置 docket
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2) // 指定api类型为swagger2
.apiInfo(apiInfo()) // 用于定义api文档汇总信息
.select()
.apis(RequestHandlerSelectors
.basePackage("com.xxx.controller")) // 指定controller包
.paths(PathSelectors.any()) // 所有controller
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("网商贷api") // 文档页标题
.contact(new Contact("xxx",
"https://www.xxx.xyz",
"[email protected]")) // 联系人信息
.description("专为网商贷提供的api文档") // 详细信息
.version("1.0.1") // 文档版本号
.termsOfServiceUrl("https://www.xxx.xyz") // 网站地址
.build();
}
}
拡張スキル
1. コントローラーを無視します: 対応するコントローラーに @ApiIgnore を追加します。
2. ドキュメント内のコントローラーは中国語で表示されます。対応するコントローラーに @Api を追加します。
例えば：
@Api(value = "注册登录", tags = {
"用于注册登录的相关接口"})
@RestController
@RequestMapping("password")
public class PassPortController {
3. ドキュメント内のメソッドは中国語を表示します。対応するメソッドに @ApiOperation を追加します。
例えば：
@ApiOperation(value = "用户注册", notes = "用户注册", httpMethod = "POST")
@PostMapping("/regist")
public IMOOCJSONResult regist(@RequestBody UserBO userBO) {
4. ドキュメントでは、フロントエンドによってインポートする必要があるエンティティとフィールドが中国語で表示され、対応するクラスとフィールドにコメントが追加され、クラスに @ApiModel が追加され、クラスに @ApiModelProperty が追加されます
。フィールド
。例:
@ApiModel(value = "用户对象BO", description = "从客户端，由用户传入的数据封装在此entity中")
@Data
public class UserBO {
@ApiModelProperty(value = "用户名", name = "username", example = "imooc", required = true)
String username;
@ApiModelProperty(value = "密码", name = "password", example = "123456", required = true)
String password;
@ApiModelProperty(value = "确认密码", name = "confirmPassword", example = "123456", required = false)
String confirmPassword;
}