Swagger的简单配置记录

来源:xiaoger 发布时间:2020-04-06 21:36:10 作者:admin 阅读量:219

swagger

1、swagger的环境搭建

就是用来在线测试Api的可用性

  • 基于springboot项目

  • 需要导入的依赖

        <!-- 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>
       <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
       <dependency>
           <groupId>io.springfox</groupId>
           <artifactId>springfox-swagger2</artifactId>
           <version>2.9.2</version>
       </dependency>
  • 需要写一个config配置类(SwaggerConfig.java):

@Configuration
@EnableSwagger2   //开启swagger2
public class SwaggerConfig {

   @Bean   //注册到ico容器中
   public Docket docket(){
       return new Docket(DocumentationType.SWAGGER_2);

   }
}

2、配置swagger的信息

  • 在config配置类中配置

  //配置swagger的Docket的bean实例
   //RequestHandlerSelectors.basePackage()指定扫描包
   //就是只展示指定包下面的请求
   @Bean
   public Docket docket(Environment environment){
       //设置要显示的swagger环境
       Profiles profiles = Profiles.of("dev");
       //判断是否处于自己设定的环境中(用于是否启动)
       boolean flag = environment.acceptsProfiles(profiles);
       //System.out.println(flag);

       return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(apiInfo())
               .groupName("xiaoger") //分组名字
               .enable(flag) //判断是否启动
               .select()
               .apis(RequestHandlerSelectors.basePackage("com.xiaoger.swagger.controller"))
               .build();

   }

   //配置swagger信息aipinfo
   private ApiInfo apiInfo(){
       //作者信息
       Contact contact = new Contact("xiaoger", "http://xiaoger.233baidu.com", "");

       return new ApiInfo(
               "xiaoger的Api文档",
               "学无止境",
               "1.0",
               "http://xiaoger.233baidu.com",
               contact,
               "Apache 2.0",
               "http://www.apache.org/licenses/LICENSE-2.0",
               new ArrayList());

   }
  • 编写实体类,而且可以给实体类加上注释信息(也就是在swagger页面查看时明白字段的意思是啥)

@ApiModel("用户实体类")  //就是个注释的注解,没啥用
public class User {
   @ApiModelProperty("用户名")
   private String username;
   @ApiModelProperty("密码")
   private String password;
}
  • 用了以后的效果(有个注释更清楚)


Original article, reproduced please specify:Swagger的简单配置记录 | xiaoger

(本站所有资源来源于网络,仅供学习交流使用,本站不承担关于本资源的任何法律责任。)
上一篇:mybatis-plus
下一篇:

我要评论 登录后才能发布评论

  Article archive

感谢鲶鱼博客提供的模板   我要留言
中央许可免备案
Catfish(鲶鱼) CMS V 6.2.6