[Java] 手把手教你SpringBoot快速集成Swagger的配置过程

<!--web方便测试-->
   <dependency>
   <groupid>org.springframework.boot</groupid>
   <artifactid>spring-boot-starter-web</artifactid>
   </dependency>
   <!-- swagger2核心包 -->
   <dependency>
   <groupid>io.springfox</groupid>
   <artifactid>springfox-swagger2</artifactid>
   <version>2.9.2</version>
   </dependency>
   <!-- swagger-ui 可视化界面 -->
   <dependency>
   <groupid>io.springfox</groupid>
   <artifactid>springfox-swagger-ui</artifactid>
   <version>2.9.2</version>
   </dependency>

package com.example.config;
 
import org.springframework.context.annotation.bean;
import org.springframework.context.annotation.configuration;
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 //开启swagger的使用
public class swaggerconfig {
 
  @bean  //swagger的使用主要是要将docket对象传入ioc容器
  public docket docket(){
  return new docket(documentationtype.swagger_2)
    .apiinfo(apiinfo()) //关于文档的各种信息
    .enable(true) //使swagger生效
    .groupname("常安祖")
    .select()//选择扫描的接口
    .apis(requesthandlerselectors.basepackage("com.example.controller"))//指定扫描的接口
    .build();
  }
 
 
  public apiinfo apiinfo(){
  contact contact = new contact("长安","https://blog.csdn.net/weixin_45647685","719801748@qq.com");//个人的联系方式
  return new apiinfo("长安的文档", "长安的开发文档", "1.0", "urn:tos",null, "apache 2.0", "http://www.apache.org/licenses/license-2.0", new arraylist());//文档的各种信息
  }
}

@apimodel("用户的实体类")
public class user implements serializable {
 
  @apimodelproperty("用户的id")
  private integer id;
 
  @apimodelproperty("用户的姓名")
  private string name;
 
  @apimodelproperty("用户的年纪")
  private integer age;
 
  public integer getid() {
  return id;
  }
  public user(integer id, string name, integer age) {
  this.id = id;
  this.name = name;
  this.age = age;
  }
 
  public void setid(integer id) {
  this.id = id;
  }
 
  public string getname() {
  return name;
  }
 
  public void setname(string name) {
  this.name = name;
  }
 
  public integer getage() {
  return age;
  }
 
  public void setage(integer age) {
  this.age = age;
  }
}

package com.yangzihao.controller;
 
import com.yangzihao.entity.user;
import io.swagger.annotations.apimodelproperty;
import org.springframework.stereotype.controller;
import org.springframework.web.bind.annotation.getmapping;
import org.springframework.web.bind.annotation.requestmapping;
 
@restcontroller
public class usercontroller {
 
  @apimodelproperty("得到一个user")
  @getmapping("/getuser")
  public user getuser(){
  return new user(1,"测试",18);
  }
}