?
1.引入依賴，版本3.0.0只引入一個即可
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
2. 配置類SwaggerConfig
package org.fh.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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
* 說明：Swagger 介面API生成
* 作者：FH Admin
* from fhadmin.org
*/
@Configuration
@EnableOpenApi
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("org.fh.controller")) // 為當前包路徑
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("FH Admin Swagger3 RESTful API") // 頁面標題
.version("3.0") // 版本號
.description("fhadmin.org") // 描述
.build();
}
}
3.Swagger 攔截配置
package org.fh.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* 說明：Swagger 攔截配置
* 作者：FH Admin
* from fhadmin.org
*/
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.
addResourceHandler("/swagger-ui/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
.resourceChain(false);
}
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/swagger-ui/")
.setViewName("forward:/swagger-ui/index.html");
}
}
4.訪問 127.0.0.1:8081/swagger-ui/index.html
5.介面說明案例
處理類上加注解，比如
@Api("用戶注冊登錄介面")
在方法上加注解，比如
@ApiOperation(value = "https://www.cnblogs.com/m17054598469/p/登錄", notes="校驗登錄是否成功")
@ApiImplicitParam(name = "KEYDATA", value = "https://www.cnblogs.com/m17054598469/p/用戶名密碼混淆碼組合", paramType = "query", required = true, dataType = "String")------------------------------------------------------------------自定義表單
28. 定義模版：拖拽左側表單元素到右側區域，編輯表單元素，保存表單模版
29. 表單模版：編輯維護表單模版，復制表單模版，修改模版型別，預覽表單模版
30. 我的表單：選擇表單模版，編輯表單規則，是否上傳圖片、附件、開啟富文本、掛靠流程開關等
31. 表單資料：從我的表單進去可增刪改查表單資料，修改表單規則
32. 掛靠記錄：記錄表單資料和流程實體ID關聯記錄，可洗掉
?
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/380174.html
標籤：Java