ホームページ  >  記事  >  Java  >  Springboot 構成 Swagger3 を更新する方法

Springboot 構成 Swagger3 を更新する方法

WBOY
WBOY転載
2023-05-27 20:30:031013ブラウズ

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")

ワークフロー モジュールを 1 つ導入するだけで済みます。 ----------------------------------www.fhadmin.cn

1. モデル管理: Web オンライン プロセス デザイナー、XML のインポートとエクスポート、プロセスのコピー、プロセスの展開

2. プロセス管理: プロセス リソース ファイルのインポートとエクスポート、フローチャートの表示、プロセス インスタンスに基づくプロセス モデルの反映、一時停止のアクティブ化

3. 実行中のプロセス: プロセス情報の表示、現在のタスク ノード、現在のフローチャート、プロセスの無効化と一時停止、To-Do 担当者の割り当て、フリー ジャンプ

4. 履歴プロセス: プロセス情報の表示、プロセス時間、プロセス ステータス、タスク開始者情報の表示

5. To Do タスク: 個人タスクとこのロールのタスクを表示し、処理、拒否、無効化し、エージェントを割り当てます

6. すでにタスクの処理:これまでに処理したタスクや処理情報、フローチャート、処理状況を確認します(キャンセルや拒否は正常に完了しています)

タスクを処理する際、コピーするユーザーを選択できます。コピーされる人へのサイト内メッセージ通知 現在の承認意見と発言情報

注: 現在のタスクが完了すると、次のタスクを完了する人は、次のタスク メッセージ リマインダーを受け取ります。インスタント メッセージング。タスクがキャンセルされて完了すると、

タスクの開始者はサイト内メッセージ通知を受け取ります

以上がSpringboot 構成 Swagger3 を更新する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事はyisu.comで複製されています。侵害がある場合は、admin@php.cn までご連絡ください。