SpringBoot集成Swagger

已于 2022-02-28 15:19:42 修改
阅读量2.2k 收藏 2
点赞数
分类专栏： swagger2 文章标签： spring boot java spring
于 2022-02-17 20:07:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_45974277/article/details/122989265
版权

SpringBoot集成Swagger => springfox，两个jar包

  • Springfox-swagger2

  • swagger-swagger-ui

添加Maven依赖

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

package com.example.blog.cofig;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.web.bind.annotation.GetMapping;
import springfox.documentation.builders.BuilderDefaults;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2 //开启swagger2
@EnableKnife4j
public class SwaggerConfig {
    @Bean
    public Docket docket1() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("用户1");
    }

    @Bean
    public Docket docket2() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("用户2");
    }

    @Bean
    public Docket docket3() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("用户3");
    }

    //配置了swagger的docket的bean实例
    @Bean
    public Docket docket(Environment environment) {
        //设置要显示的swagger2环境
        Profiles profiles = Profiles.of("dev");

        //通过environment.acceptsProfiles(profiles)判断是否处在自己设定的环境中
        //如果环境是dev,那就是true，如果是prod就是false
        boolean environmentFlag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("苏七")
                .enable(environmentFlag) //是否启用swagger2
                .select() //通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                /*RequestHandlerSelectors类中的方法
                basePackages:指定要扫描的包
                any:扫描全部
                none:什么都不扫
                withMethodAnnotation:扫描方法上的注解,比如
                RequestHandlerSelectors.withMethodAnnotation(GetMapping.class)扫描注解带有GetMapping的handler
                扫描类上的注解
                RequestHandlerSelectors.withClassAnnotation(Controller.class)扫描注解带有GetMapping的handler
                * */
                .apis(RequestHandlerSelectors.basePackage("com.example.blog.controller"))
                .build();
    }

    //配置apiInfo
    public ApiInfo apiInfo() {
        /*作者信息*/
        Contact contact = new Contact("苏七", "http://blog.suqiqaq.cn", "1141793961@qq.com");

        return new ApiInfo("blog-api Documentation",
                "博客前端文档",
                "v1.0",
                "http://blog.suqiqaq.cn",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

点击docket,可以看到swagger2只能通过构造方法进行配置，因为没有set方法，并且主要设置apiInfo

package springfox.documentation.spring.web.plugins;


public class Docket implements DocumentationPlugin {
    public static final String DEFAULT_GROUP_NAME = "default";
    private final DocumentationType documentationType;
    private final List<SecurityContext> securityContexts = Lists.newArrayList();
    private final Map<RequestMethod, List<ResponseMessage>> responseMessages = Maps.newHashMap();
    private final List<Parameter> globalOperationParameters = Lists.newArrayList();
    private final List<Function<TypeResolver, AlternateTypeRule>> ruleBuilders = Lists.newArrayList();
    private final Set<Class> ignorableParameterTypes = Sets.newHashSet();
    private final Set<String> protocols = Sets.newHashSet();
    private final Set<String> produces = Sets.newHashSet();
    private final Set<String> consumes = Sets.newHashSet();
    private final Set<ResolvedType> additionalModels = Sets.newHashSet();
    private final Set<Tag> tags = Sets.newHashSet();
    private PathProvider pathProvider;
    private List<? extends SecurityScheme> securitySchemes;
    private Ordering<ApiListingReference> apiListingReferenceOrdering;
    private Ordering<ApiDescription> apiDescriptionOrdering;
    private Ordering<Operation> operationOrdering;
    private ApiInfo apiInfo;
    private String groupName;
    private boolean enabled;
    private GenericTypeNamingStrategy genericsNamingStrategy;
    private boolean applyDefaultResponseMessages;
    private String host;
    private Optional<String> pathMapping;
    private ApiSelector apiSelector;
    private boolean enableUrlTemplating;
    private List<VendorExtension> vendorExtensions;

    public Docket(DocumentationType documentationType) {
        this.apiInfo = ApiInfo.DEFAULT;
        this.groupName = "default";
        this.enabled = true;
        this.genericsNamingStrategy = new DefaultGenericTypeNamingStrategy();
        this.applyDefaultResponseMessages = true;
        this.host = "";
        this.pathMapping = Optional.absent();
        this.apiSelector = ApiSelector.DEFAULT;
        this.enableUrlTemplating = false;
        this.vendorExtensions = Lists.newArrayList();
        this.documentationType = documentationType;
    }


    public Docket apiInfo(ApiInfo apiInfo) {
        this.apiInfo = (ApiInfo)BuilderDefaults.defaultIfAbsent(apiInfo, apiInfo);
        return this;
    }


    ...


}

再点击apiInfo，将最下面的默认info信息复制，新建一个函数返回该信息，也就是上面SwaggerConfig的配置信息

package springfox.documentation.service;

import com.google.common.collect.Lists;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

public class ApiInfo {
    public static final Contact DEFAULT_CONTACT = new Contact("", "", "");
    public static final ApiInfo DEFAULT;
    private final String version;
    private final String title;
    private final String description;
    private final String termsOfServiceUrl;
    private final String license;
    private final String licenseUrl;
    private final Contact contact;
    private final List<VendorExtension> vendorExtensions;

    /** @deprecated */
    @Deprecated
    public ApiInfo(String title, String description, String version, String termsOfServiceUrl, String contactName, String license, String licenseUrl) {
        this(title, description, version, termsOfServiceUrl, new Contact(contactName, "", ""), license, licenseUrl, new ArrayList());
    }

    public ApiInfo(String title, String description, String version, String termsOfServiceUrl, Contact contact, String license, String licenseUrl, Collection<VendorExtension> vendorExtensions) {
        this.title = title;
        this.description = description;
        this.version = version;
        this.termsOfServiceUrl = termsOfServiceUrl;
        this.contact = contact;
        this.license = license;
        this.licenseUrl = licenseUrl;
        this.vendorExtensions = Lists.newArrayList(vendorExtensions);
    }

    public String getTitle() {
        return this.title;
    }

    public String getDescription() {
        return this.description;
    }

    public String getTermsOfServiceUrl() {
        return this.termsOfServiceUrl;
    }

    public Contact getContact() {
        return this.contact;
    }

    public String getLicense() {
        return this.license;
    }

    public String getLicenseUrl() {
        return this.licenseUrl;
    }

    public String getVersion() {
        return this.version;
    }

    public List<VendorExtension> getVendorExtensions() {
        return this.vendorExtensions;
    }

    static {
        DEFAULT = new ApiInfo("Api Documentation", "Api Documentation", "1.0", "urn:tos", DEFAULT_CONTACT, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList());
    }
}

访问测试 ：http://localhost:8777/swagger-ui.html ，可以看到swagger的界面

swagger配置扫描接口

构建Docket时通过select()方法配置怎么扫描接口。

package com.example.blog.cofig;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.web.bind.annotation.GetMapping;
import springfox.documentation.builders.BuilderDefaults;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig
{
    //配置了swagger的docket的bean实例
    @Bean
    public Docket docket()
    {

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select() //通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                /*RequestHandlerSelectors类中的方法
                basePackages:指定要扫描的包
                any:扫描全部
                none:什么都不扫
                withMethodAnnotation:扫描方法上的注解,比如
                RequestHandlerSelectors.withMethodAnnotation(GetMapping.class)扫描注解带有GetMapping的handler
                扫描类上的注解
                RequestHandlerSelectors.withClassAnnotation(Controller.class)扫描注解带有GetMapping的handler
                * */
                .apis(RequestHandlerSelectors.basePackage("com.example.blog.controller"))
                .build();


    }

    //配置apiInfo
    public ApiInfo apiInfo()
    {
        /*作者信息*/
        Contact contact = new Contact("苏七","http://8.136.84.238:8080","1141793961@qq.com");

        return new ApiInfo("blog-api Documentation",
               "博客前端文档",
               "v1.0",
               "http://8.136.84.238:8080",
                contact,
               "Apache 2.0",
               "http://www.apache.org/licenses/LICENSE-2.0",
               new ArrayList());
    }
}

Docket类中有一个enable方法,.enable可以配置是否自动开启，默认为true

Docket类中有一个select方法

public ApiSelectorBuilder select() {
        return new ApiSelectorBuilder(this);
    }
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package springfox.documentation.spring.web.plugins;

import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.Iterables;
import springfox.documentation.RequestHandler;
import springfox.documentation.spi.service.contexts.ApiSelector;

public class ApiSelectorBuilder {
    private final Docket parent;
    private Predicate<RequestHandler> requestHandlerSelector;
    private Predicate<String> pathSelector;

    public ApiSelectorBuilder(Docket parent) {
        this.requestHandlerSelector = ApiSelector.DEFAULT.getRequestHandlerSelector();
        this.pathSelector = ApiSelector.DEFAULT.getPathSelector();
        this.parent = parent;
    }

    public ApiSelectorBuilder apis(Predicate<RequestHandler> selector) {
        this.requestHandlerSelector = Predicates.and(this.requestHandlerSelector, selector);
        return this;
    }

    public ApiSelectorBuilder paths(Predicate<String> selector) {
        this.pathSelector = Predicates.and(this.pathSelector, selector);
        return this;
    }

    public Docket build() {
        return this.parent.selector(new ApiSelector(this.combine(this.requestHandlerSelector, this.pathSelector), this.pathSelector));
    }

    private Predicate<RequestHandler> combine(Predicate<RequestHandler> requestHandlerSelector, Predicate<String> pathSelector) {
        return Predicates.and(requestHandlerSelector, this.transform(pathSelector));
    }

    private Predicate<RequestHandler> transform(final Predicate<String> pathSelector) {
        return new Predicate<RequestHandler>() {
            public boolean apply(RequestHandler input) {
                return Iterables.any(input.getPatternsCondition().getPatterns(), pathSelector);
            }
        };
    }
}

里面的apis就是指定扫描的路径

paths是一个过滤器，只扫描哪些接口

                这里的可选值还有

                any() // 任何请求都扫描         

                none() // 任何请求都不扫描        

                 regex(final String pathRegex) // 通过正

则表达式控制        

                 ant(final String antPattern) // 通过ant()控制

动态配置当项目处于测试、开发环境时显示swagger，处于生产环境时不显示

 新建三个application.yaml文件

在application.yaml设置active: dev,就是处于开发环境下

spring:
  profiles:
    active: dev

application-dev.yaml：

server:
  port: 8777

application-prod.yaml：

server:
  port: 8776


package com.example.blog.cofig;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.web.bind.annotation.GetMapping;
import springfox.documentation.builders.BuilderDefaults;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig
{
    //配置了swagger的docket的bean实例
    @Bean
    public Docket docket(Environment environment)
    {
        //设置要显示的swagger2环境
        Profiles profiles = Profiles.of("dev","prod");


        //通过environment.acceptsProfiles(profiles)判断是否处在自己设定的环境中
        //如果环境是dev,那就是true，如果是prod就是false
        boolean environmentFlag = environment.acceptsProfiles(profiles);


        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(environmentFlag) //是否启用swagger2
                .select() //通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                /*RequestHandlerSelectors类中的方法
                basePackages:指定要扫描的包
                any:扫描全部
                none:什么都不扫
                withMethodAnnotation:扫描方法上的注解,比如
                RequestHandlerSelectors.withMethodAnnotation(GetMapping.class)扫描注解带有GetMapping的handler
                扫描类上的注解
                RequestHandlerSelectors.withClassAnnotation(Controller.class)扫描注解带有GetMapping的handler
                * */
                .apis(RequestHandlerSelectors.basePackage("com.example.blog.controller"))
                .build();


    }

    //配置apiInfo
    public ApiInfo apiInfo()
    {
        /*作者信息*/
        Contact contact = new Contact("苏七","http://8.136.84.238:8080","1141793961@qq.com");

        return new ApiInfo("blog-api Documentation",
               "博客前端文档",
               "v1.0",
               "http://8.136.84.238:8080",
                contact,
               "Apache 2.0",
               "http://www.apache.org/licenses/LICENSE-2.0",
               new ArrayList());
    }
}

所以只有在dev下，swagger2才会开启

配置API分组

目的：每个人配置自己的分组，就可以修改自己的接口文档，也就可以协同开发了

1、如果没有配置分组，默认是default。通过groupName()方法即可配置分组：

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("苏七") // 配置分组
       //....
}

2、重启项目查看分组

3、如何配置多个分组？配置多个分组只需要配置多个docket即可：

package com.example.blog.cofig;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.web.bind.annotation.GetMapping;
import springfox.documentation.builders.BuilderDefaults;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2 //开启swagger2
public class SwaggerConfig
{
    @Bean
    public Docket docket1()
    {
        return new Docket(DocumentationType.SWAGGER_2).groupName("用户1");
    }

    @Bean
    public Docket docket2()
    {
        return new Docket(DocumentationType.SWAGGER_2).groupName("用户2");
    }

    @Bean
    public Docket docket3()
    {
        return new Docket(DocumentationType.SWAGGER_2).groupName("用户3");
    }

    //配置了swagger的docket的bean实例
    @Bean
    public Docket docket(Environment environment)
    {
        //设置要显示的swagger2环境
        Profiles profiles = Profiles.of("dev","prod");


        //通过environment.acceptsProfiles(profiles)判断是否处在自己设定的环境中
        //如果环境是dev,那就是true，如果是prod就是false
        boolean environmentFlag = environment.acceptsProfiles(profiles);
        
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("苏七")
                .enable(environmentFlag) //是否启用swagger2
                .select() //通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                /*RequestHandlerSelectors类中的方法
                basePackages:指定要扫描的包
                any:扫描全部
                none:什么都不扫
                withMethodAnnotation:扫描方法上的注解,比如
                RequestHandlerSelectors.withMethodAnnotation(GetMapping.class)扫描注解带有GetMapping的handler
                扫描类上的注解
                RequestHandlerSelectors.withClassAnnotation(Controller.class)扫描注解带有GetMapping的handler
                * */
                .apis(RequestHandlerSelectors.basePackage("com.example.blog.controller"))
                .build();
    }

    //配置apiInfo
    public ApiInfo apiInfo()
    {
        /*作者信息*/
        Contact contact = new Contact("苏七","http://8.136.84.238:8080","1141793961@qq.com");

        return new ApiInfo("blog-api Documentation",
               "博客前端文档",
               "v1.0",
               "http://8.136.84.238:8080",
                contact,
               "Apache 2.0",
               "http://www.apache.org/licenses/LICENSE-2.0",
               new ArrayList());
    }
}

刷新页面，就可以在右上角查看自己分组 

 实体类配置

 1.给实体类添加注解

@ApiModel("发布文章前端所传递的参数")
@Data
public class ArticleParam
{
    @JsonSerialize(using = ToStringSerializer.class)
    private Long id;

    private ArticleBodyParam body;

    private CategoryVo category;

    @ApiModelProperty("文章摘要")
    private String summary;

    private List<TagVo> tags;/*文章标签*/

    private String title;
}

2.实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

    /**
     * 首页 文章列表
     * @param pageParams
     * @return
     */
    @PostMapping
    @Cache(expire = 5 *60 * 1000,name = "list_article")
    public Result listArticle(@RequestBody PageParams pageParams)
    {
        return articleService.listArticle(pageParams);
    }

3、重启查看测试

注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

@ApiModel为类添加注释

@ApiModelProperty为类属性添加注释

常用注解

Swagger注解简单说明
@Api(tags = "xxx模块说明")作用在模块类上
@ApiOperation("xxx接口说明")作用在接口方法上
@ApiModel("xxxPOJO说明")作用在模型类上：如VO、BO
@ApiModelProperty(value = "xxx属性说明",hidden = true)作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam("xxx参数说明")作用在参数、方法和字段上，类似@ApiModelProperty

我们也可以给请求的接口配置一些注释

    /**
     * 首页 文章列表
     * @param pageParams
     * @return
     */
    @PostMapping
    @Cache(expire = 5 *60 * 1000,name = "list_article")
    @ApiOperation("文章列表接口")
    public Result listArticle(@ApiParam("前端传递的参数") @RequestBody PageParams pageParams)
    {
        return articleService.listArticle(pageParams);
    }

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。

拓展：其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

bootstrap-ui  访问 http://localhost:8777/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

Layui-ui   访问 http://localhost:8777/docs.html

<dependency>
   <groupId>com.github.caspar-chen</groupId>
   <artifactId>swagger-ui-layer</artifactId>
   <version>1.1.3</version>
</dependency>

mg-ui   访问 http://localhost:8777/document.html

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>

Knife4j   访问 http://localhost:8777/doc.html

<!--整合Knife4j-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.4</version>
</dependency>

  • 在Swagger2Config中增加一个@EnableKnife4j注解，该注解可以开启knife4j的增强功能；

  • @Configuration
@EnableSwagger2 //开启swagger2
@EnableKnife4j
public class SwaggerConfig
{...}

knife4j部署到服务器

前后端部署可以移步到13.博客部署_欧尼酱owo的博客-优快云博客1.云服务器的购买：2.域名申请+备案3.安装Xshell4.将服务器的公网ip设置在xshell新建会话中的上，5.输入服务器创建的实例的实例密码这样就是显示已连接6.安装宝塔输入到xshell中安装完成7.使用阿里云服务器ECS安装BT宝塔面板，安装完毕后宝塔面板会提示，若无法访问面板，请检查防火墙/安全组是否有放行面板[8888]端口，需要配置服务器在入方向进行手动添加8.复制外网面板地址用浏览器打...https://blog.youkuaiyun.com/weixin_45974277/article/details/122828932

将后端项目重新打包，上传到服务器

由于nginx代理了后端端口，所以直接在网站端口上加上/api/doc.html,也就是

http://域名/api/doc.html即可

Spring Boot：整合Swagger文档
qq_42227281的博客
10-09 429
综合概述 spring-boot作为当前最为流行的Java web开发脚手架，越来越多的开发者选择用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的web端（b/s），也会服务于移动端。在实际开发过程中，这些接口还要提供给开发测试进行相关的白盒测试，那么势必存在如何在多人协作中共享和及时更新API开发接口文档的问题。 假如你已经对传统的wiki文档共享方式所带来的弊端深...
SpringBoot配置Swagger接口文档及美化增强依赖
qq_62015542的博客
12-07 2597
在springboot配置不同的swagger接口文档
springfox.documentation.spring.web.readers.operation.CachingOperationNameGenerator 类详解
爱的叹息的专栏
04-23 487
springfox.documentation.spring.web.readers.operation.CachingOperationNameGenerator 类详解
springboot集成springfox本地查看文档
无名小卒菜的博客
06-01 1048
pom.xm <!-- springfox --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </.
SpringBoot学习 日志集成（六）
日薪灬越亿的博客
12-07 223
java有许多的日志组件，比如 log4j,log4j2,logback还有java自生提供的Java Util Logging，其实在springboot中对这些组件都提供了支持，log4j，log4j2和logback都提供相应的组件支持。 Logback 在springboot中默认使用的日志工具是logback,不过在提及具体的日志工具之前要提一个名词，这个名词就是slf4j(Sim...
Springfox Swagger2从入门到精通
m0_63251896的博客
01-26 3812
Swagger 是一种用于设计、构建、文档化和使用 RESTful API 的工具。Springfox 是 Swagger 在 Spring 应用中的集成库，提供了自动生成 API 文档的功能。在本文中，我们将探讨如何使用 Springfox Swagger2 在 Spring Boot 项目中生成、配置和使用 API 文档。
SpringBoot集成Swagger简单使用
12-22
总结来说，SpringBoot集成Swagger的步骤包括：引入相关依赖，创建Swagger配置类，编写API注解，通过Swagger UI访问和测试API。这个过程使得API的文档化和测试工作变得简单且高效，极大地提高了开发效率和API的可维护...
springboot集成swagger
09-16
SpringBoot集成Swagger详解 在现代Web开发中，API文档的重要性不言而喻，它能帮助开发者理解接口的使用方法和参数。Swagger是一个优秀的API文档工具，可以自动化地生成清晰、直观的API文档，大大减轻了编写和维护...
SpringBoot集成Swagger2
m0_64681527的博客
06-11 659
面向个人、团队和企业的API工具在前后端分离时代，我们怎么做到再接口开发完毕后，确保接口能“及时协商，尽早解决”？此时，Swagger自动生成Api文档帮助我们解决此难题！集成Swagger只需要我们导入配置，做简单的配置即可使用。也是面向框架编程的思想。
springfox.documentation.spi.DocumentationType配置示例
weixin_30699831的博客
12-14 1357
Java Code Examples for springfox.documentation.spi.DocumentationTypeThe following are top voted examples for showing how to use springfox.documentation.spi.DocumentationType. These examples are extrac...
【Swagger2源码级教学】03扫描接口
m0_55659498的博客
09-15 1185
上节我们初步了解Docket，接下来我们继续了解Docket内的配置方法。
Spring Boot配置Swagger增强工具
m0_38075227的博客
01-13 4175
参考knife4j官方网站：1.6 快速开始 | knife4j 一、话不多说，先看效果 1.Swagger页面这样，这里就不多做介绍 2.增强后的首页 3.API列表 4.API请求参数 5.API响应参数 个人觉得增强后看着很清晰，比原来的要好很多。 二、开始配置 1.pom.xml 配置 <dependency> <groupId>io.springfox</groupId> ...
Spring Boot——集成Swagger
一心同学的博客
12-31 4587
保姆级别讲解Swagger工具，讲解关于Swagger的各种实用知识点以及注意事项。
springfox 源码分析(四) 配置类初始化
八一菜刀的专栏
10-06 3088
时间：2019-5-23 12:46:50 地点：单位、家中 @EnableSwagger2 有了二三章的理解,此时我们再来看EnableSwagger2注解的内容 @Retention(value = java.lang.annotation.RetentionPolicy.RUNTIME) @Target(value = { java.lang.annotation.ElementT...
SpringBoot集成Swagger2生成Api文档
a1939504134的博客
05-12 2692
只需添加少量注解，就可生成详细的接口文档以及ui界面，提高开发效率
SpringBoot 通过配置禁用swagger
Lambda
05-29 1780
SpringBoot 通过配置禁用swagger 禁用方法1： 禁用方法2： 禁用方法3： 一、序言 在生产环境下，我们需要关闭swagger配置，避免暴露接口的这种危险行为。 二、方法： 禁用方法1： 使用注解 @Value() 推荐使用 package com.dc.config; import org.springframework.boot.autoconfigure...
SpringBoot 系列教程(四十三)：SpringBoot2.x集成Swagger2配置(解决404报错)
Thinkingcao的专栏
07-30 3444
在 spring boot 项目中配置 Swagger2 突然出现了 404 报错, 究其原因,是因为 MVC 没有找到 swagger-ui 包中的 swagger-ui.html 文件; 以下就是 swagger2 的配置,及解决方案: 一, 引入Maven : <dependency> <!-- API --> <...
SpringBoot与Swagger整合的RESTful API开发指南
最新发布
weixin_33173126的博客
05-18 749
Swagger UI通常可以通过访问，但有时我们可能需要改变这个路径，以适应不同的需求或安全策略。通过配置apis()方法，可以指定Swagger的扫描范围，并通过来自定义访问路径。// ....select().build()@Override// 自定义路径});在这个示例中，通过方法设置了一个新的API路径，这意味着所有的Swagger UI和文档将会通过新的路径访问。通过Docket的select()方法，你可以设置自定义的扫描规则。
springboot 集成 swagger
08-16
要在Spring Boot中集成Swagger，你需要做以下几个步骤： 1. 首先，确保你使用的是Spring Boot 2.5.x及之前的版本。因为从Spring Boot 2.6.x开始，Swagger已经从Spring Boot中移除了。 2. 在你的Spring Boot应用中添加Swagger的依赖。在pom.xml文件中，添加以下依赖： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 3. 在启动类上添加`@EnableSwagger2`注解。这个注解会启用Swagger的功能。你可以将这个注解直接添加到你的Spring Boot启动类上，或者创建一个单独的配置类，在配置类中添加这个注解。 4. 配置Swagger的相关属性。你可以在`application.properties`或`application.yml`文件中添加以下配置： ```yaml springfox.documentation.swagger.v2.path=/swagger springfox.documentation.swagger.ui.enabled=true ``` 这些配置将指定Swagger的路径和UI的启用状态。 5. 编写API文档。在你的控制器类中，使用Swagger的注解来描述你的API接口。例如，你可以使用`@Api`注解来给你的控制器类添加一个API的描述，<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* *3* [SpringBoot教程(十六) | SpringBoot集成swagger（全网最全）](https://blog.csdn.net/lsqingfeng/article/details/123678701)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT3_1"}}] [.reference_item style="max-width: 100%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值