springboot更新配置Swagger3的一些小技巧

Posted on by

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.cn
 */
@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.cn
 */
@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.cn

1.模型管理：web在線流程設計器、導入導出xml、復制流程、部署流程

2.流程管理：導入導出流程資源文件、查看流程圖、根據流程實例反射出流程模型、激活掛起

3.運行中流程：查看流程信息、當前任務節點、當前流程圖、作廢暫停流程、指派待辦人、自由跳轉

4.歷史的流程：查看流程信息、流程用時、流程狀態、查看任務發起人信息

5.待辦任務：查看本人個人任務以及本角色下的任務、辦理、駁回、作廢、指派一下代理人

6.已辦任務：查看自己辦理過的任務以及流程信息、流程圖、流程狀態(作廢 駁回 正常完成)

辦理任務時候可以選擇用戶進行抄送，就是給被抄送人發送站內信通知當前審批意見以及備註信息

註：當辦理完當前任務時，下一任務待辦人會即時通訊收到新任務消息提醒，當作廢和完結任務時,

任務發起人會收到站內信消息通知

到此這篇關於springboot Swagger3 更新配置的一些小技巧的文章就介紹到這瞭,更多相關springboot Swagger3 更新配置內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：