栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

spring2.6.7集成swagger

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

spring2.6.7集成swagger

  1. 新建springboot项目,版本选择2.6.7
  2. pom文件添加swagger,版本为2.9.2


  4.0.0
  
    org.springframework.boot
    spring-boot-starter-parent
    2.6.7
     
  
  com.yf
  security-oauth2
  0.0.1-SNAPSHOT
  security-oauth2
  Demo project for Spring Boot
  
    1.8
  
  
    
      org.springframework.boot
      spring-boot-starter-security
    
    
      org.springframework.boot
      spring-boot-starter-web
    

    
      org.springframework.security.oauth
      spring-security-oauth2
      2.3.6.RELEASE
    

    
      org.springframework.security.oauth.boot
      spring-security-oauth2-autoconfigure
      2.1.2.RELEASE
    

    
    
      io.springfox
      springfox-swagger2
      2.9.2
    
    
      io.springfox
      springfox-swagger-ui
      2.9.2
    

    
      org.projectlombok
      lombok
      1.18.18
    
  

  
    
      
        org.springframework.boot
        spring-boot-maven-plugin
      
    
  



  1. 添加swagger配置类
package com.yf.securityoauth2.config;

import io.swagger.annotations.Api;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
public class Swagger2Configuration {
  @Bean
  public Docket createRestApi(){
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        //.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
        .apis(RequestHandlerSelectors.basePackage("com.yf.securityoauth2.controller"))
        .paths(PathSelectors.any())
        .build();
  }

  //基本信息的配置,信息会在api文档上显示
  private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
        .title("spring security测试的接口文档")
        .description("用于描述spring security接口的详细文档")
        .termsOfServiceUrl("http://www.baidu.com")
        .version("1.0")
        .build();
  }

}

  1. 添加配置文件
server:
  port: 8012
spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher
# 防止访问控制台时报参数类型转换异常
logging:
  level:
    io:
      swagger:
        models:
          parameters:
            AbstractSerializableParameter: error

  1. 注解用法
    5.1@Api 用于标识类,表示该类是Swagger的资源

    5.2@ApiIgnore 用于表示类,值忽略对该类的扫描
    5.3@ApiOperation 用于方法,描述 Controller类中的 method接口
    5.4@ApiParam: 用于参数,单个参数描述,与 @ApiImplicitParam不同的是,他是写在参数左侧的。如( @ApiParam(name=“username”,value=“用户名”)Stringusername)
    5.5@ApiModel: 用于类,表示对类进行说明,用于参数用实体类接收
    5.6@ApiProperty:用于方法,字段,表示对model属性的说明或者数据操作更改
    5.7@ApiImplicitParam: 用于方法,表示单独的请求参数
    5.8@ApiImplicitParams: 用于方法,包含多个 @ApiImplicitParam

5.9@ApiResponse: 用于方法,描述单个出参信息
5.10@ApiResponses: 用于方法,包含多个@ApiResponse
5.10@ApiError: 用于方法,接口错误所返回的信息

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/860127.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号