首頁 >Java >java教程 >springboot怎麼更新配置Swagger3

springboot怎麼更新配置Swagger3

WBOY
WBOY轉載
2023-05-27 20:30:031086瀏覽

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的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文轉載於:yisu.com。如有侵權,請聯絡admin@php.cn刪除