第二步:整合Swagger3(实现线上API)

本文档介绍了如何在Java Spring Boot项目中整合Swagger3,包括添加依赖、启用OpenApi注解、配置Swagger、在Controller中使用注释、调整MBG生成规则,并展示如何运行和查看整合后的Swagger接口平台。
摘要由CSDN通过智能技术生成

swagger3

1 添加依赖
<!--Swagger-UI API文档生产工具-->
<dependency>
	<groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
2 添加注释

在SpringBoot入口添加@EnableOpenApi注释

package com.hzf.mymall;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.oas.annotations.EnableOpenApi;

@EnableOpenApi
@SpringBootApplication
public class MymallApplication {
   

    public static void main(String[] args) {
   
        SpringApplication.run(MymallApplication.class, args);
    }

}
3 添加Swagger的Java配置
package com.hzf.mymall.config;

import io.swagger.annotations.ApiOperation;
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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author:010980380
 * @date:2020-10-27
 * @verison:1.0.0
 * @description:Swagger3配置文件
 */
@Configuration
public class SwaggerConfig {
   

    @Bean
    public Docket createRestApi() {
   
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {<
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值