ホームページ > Java > &#&チュートリアル > springboot が swagger3 とナイフ 4j を統合する方法

springboot が swagger3 とナイフ 4j を統合する方法

王林
リリース: 2023-05-19 12:49:06
転載
2065 人が閲覧しました

springboot は swagger3

swagger3 の springboot スターター jar パッケージを統合します

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
ログイン後にコピー

注: 現在の SpringBoot バージョンは 2.5.6 であり、Swagger3.0 は現在 SpringBoot2 と完全には互換性がありません。 6.×!

TestController コードの作成

@RestController
@RequestMapping("test")
public class TestController {
    @GetMapping
    public Map<String, Object> get(@RequestParam String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @PostMapping
    public Map<String, Object> post() {
        Map<String, Object> r = new HashMap<>(1);
        r.put("code", 200);
        return r;
    }
    @PutMapping
    public Map<String, Object> put(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @DeleteMapping
    public Map<String, Object> delete(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }
}
ログイン後にコピー

Swagger3Configuration の作成

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    private static final String VERSION = "0.0.1";
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .groupName("分组名称")
                .apiInfo(apiInfo())
                .select()
                //要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置标题
                .title("文档标题")
                //联系人
                .contact(contact())
                //描述
                .description("xxx文档")
                //服务
                .termsOfServiceUrl("https://spring.io/")
                //许可证
                .license("Apache 2.0")
                .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
                .version(VERSION)
                .build();
    }
    private Contact contact (){
        return new Contact("SpringBoot", "https://spring.io/", "email");
    }
}
ログイン後にコピー

インターフェイスに注釈を付ける

Swagger で一般的に使用される注釈
#AnnotationFunctionUse location##@Api@ApiOperation@ApiImplicitParams@ApiImplicitParam@ApiModel@ApiModelProperty@ApiIgnore#Attributesインターフェイスの基本的な使用法
を示します。共通パラメータClass
メソッドの目的の説明Method
複数の @ApiImplicitParamMethod
を含めることができます説明 パラメータの目的Method
データ クラスの情報を表しますClass
データ クラスのプロパティを記述しますProperties
データ クラスのプロパティを記述します。
1. 新しいユーザー エンティティを作成するclass
@ApiModel("用户")
@Data
public class User {
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
}
ログイン後にコピー
2. TestController へのアノテーションの追加

@Api(tags = "测试接口")
@RestController
@RequestMapping("test")
public class TestController {
    @ApiOperation("get请求")
    @GetMapping
    @ApiImplicitParam(name = "id", value = "测试用id", dataTypeClass = String.class)
    public Map<String, Object> get(@RequestParam String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @ApiOperation("post请求")
    @PostMapping
    public Map<String, Object> post(@RequestBody User user) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("code", 200);
        return r;
    }

    @ApiOperation("put请求")
    @PutMapping
    @ApiImplicitParam(name = "id", value = "put请求id", dataTypeClass = String.class)
    public Map<String, Object> put(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }

    @ApiOperation("delete请求")
    @DeleteMapping
    @ApiImplicitParam(name = "id", value = "delete请求id", dataTypeClass = String.class)
    public Map<String, Object> delete(String id) {
        Map<String, Object> r = new HashMap<>(1);
        r.put("id", id);
        return r;
    }
}
ログイン後にコピー

実行結果

springboot が swagger3 とナイフ 4j を統合する方法

springboot が swagger3 とナイフ 4j を統合する方法

##統合の改善 UI-knife4j

springboot が swagger3 とナイフ 4j を統合する方法maven

<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-micro-spring-boot-starter</artifactId>
   <version>3.0.3</version>
</dependency>
ログイン後にコピー

Enabler

SwaggerConfig クラスに **@EnableKnife4j**
@Configuration
@EnableOpenApi
@EnableKnife4j
public class SwaggerConfig
ログイン後にコピー
を追加

以上がspringboot が swagger3 とナイフ 4j を統合する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

関連ラベル:
ソース:yisu.com
このウェブサイトの声明
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。
人気のチュートリアル
詳細>
最新のダウンロード
詳細>
ウェブエフェクト
公式サイト
サイト素材
フロントエンドテンプレート