spring springfox-swagger2 2.7.0配置

springboot版本

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

springfox-swagger2 的pom

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

配置

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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
   

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket restApi() {
   
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("标准接口")
                .apiInfo(apiInfo("Spring Boot中使用Swagger2构建RESTful APIs", "1.0"))
                .useDefaultResponseMessages(true)
                .forCodeGeneration(false)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxxx.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息(这些基本信息会展现在文档页面中)
     * 访问地址:http://ip:port/swagger-ui.html
     *
     * @return
     */
    private ApiInfo apiInfo(String title, String version) {
   
        return new ApiInfoBuilder()
                .title(title)
                .description("")
                .termsOfServiceUrl("")
                .contact(new Contact("","",""))
                .version(version)
                .build();
    }
}

样子

在这里插入图片描述

请求对象的属性里加上默认值

    @ApiModelProperty(value = "属性名称", name = "xxx" , example = "swagger显示的默认值")
    private String xxx;

相关推荐

  1. Swagger使用配置笔记

    2024-01-18 11:32:08       13 阅读
  2. 华为eNSP AR2220路由器配置教程

    2024-01-18 11:32:08       51 阅读
  3. <span style='color:red;'>Swagger</span>

    Swagger

    2024-01-18 11:32:08      17 阅读

最近更新

  1. TCP协议是安全的吗?

    2024-01-18 11:32:08       16 阅读
  2. 阿里云服务器执行yum,一直下载docker-ce-stable失败

    2024-01-18 11:32:08       16 阅读
  3. 【Python教程】压缩PDF文件大小

    2024-01-18 11:32:08       15 阅读
  4. 通过文章id递归查询所有评论(xml)

    2024-01-18 11:32:08       18 阅读

热门阅读

  1. Linux 常用的一些命令

    2024-01-18 11:32:08       33 阅读
  2. 商务和技术标书的区别

    2024-01-18 11:32:08       34 阅读
  3. utf8mb4字符集

    2024-01-18 11:32:08       27 阅读
  4. swagger知识讲解

    2024-01-18 11:32:08       28 阅读
  5. Lua 中的do...end和repeat...until

    2024-01-18 11:32:08       31 阅读
  6. ValueError: too many values to unpack (expected 2)

    2024-01-18 11:32:08       18 阅读