SpringBoot整合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;

/**

  * swagger的配置类

  * @author 陈加兵

  *

  */

@configuration

public class swaggerconfig{

  /**

  * 创建用户api文档

  * @return

  */

  @bean

  public docket createrestuserapi(){

  return new docket(documentationtype.swagger_2)

  .groupname( "user" )

  .apiinfo(apiinfo()) //api的信息

  .select()

  .apis(requesthandlerselectors

   .basepackage( "cn.tedu.mycat.controller" )) //添加包扫描

  .paths(pathselectors.any()).build();

  }

  /**

  * 创建api信息

  */

  private apiinfo apiinfo(){

  return new apiinfobuilder()

  .title( "api文档的标题" ) //标题

  .description( "api文档的描述" ) //描述

  .contact( //添加开发者的一些信息

   new contact( "爱撒谎的男孩" , "https://chenjiabing666.github.io" ,

   "18796327106@163测试数据" )).version( "1.0" ).build();

  }

}

@apioperation (value= "根据用户id获取用户信息" ,response=user. class ,hidden= false )

  @apiimplicitparams ({

  @apiimplicitparam (paramtype = "path" , name = "id" , datatype= "integer" , required = false , value = "用户的id" , defaultvalue = "1" )

  })

  @getmapping ( "/user/get/{id}" )

  public object getuser( @pathvariable ( "id" )integer id){

  return new user(id, "陈加兵" );

  }