Swagger3 更新配置詳解
阿新 • • 發佈:2021-06-19
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 = "登入", notes="請求登入驗證使用者介面,校驗登入是否成功")
@ApiImplicitParam(name = "KEYDATA", value = "使用者名稱密碼混淆碼組合", paramType = "query", required = true, dataType = "String")
工作流模組-------------------------------www.fhadmin.org
1.模型管理:web線上流程設計器、匯入匯出xml、複製流程、部署流程
2.流程管理:匯入匯出流程資原始檔、檢視流程圖、根據流程例項反射出流程模型、啟用掛起
3.執行中流程:檢視流程資訊、當前任務節點、當前流程圖、作廢暫停流程、指派待辦人、自由跳轉
4.歷史的流程:檢視流程資訊、流程用時、流程狀態、檢視任務發起人資訊
5.待辦任務:檢視本人個人任務以及本角色下的任務、辦理、駁回、作廢、指派一下代理人
6.已辦任務:檢視自己辦理過的任務以及流程資訊、流程圖、流程狀態(作廢 駁回 正常完成)
辦理任務時候可以選擇使用者進行抄送,就是給被抄送人傳送站內信通知當前審批意見以及備註資訊
注:當辦理完當前任務時,下一任務待辦人會即時通訊收到新任務訊息提醒,當作廢和完結任務時,
任務發起人會收到站內信訊息通知