SpringBoot集成Swagger2构建在线API文档的代码详解

<!--swagger2配置-->
    <dependency>
      <groupid>io.springfox</groupid>
      <artifactid>springfox-swagger-ui</artifactid>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupid>io.springfox</groupid>
      <artifactid>springfox-swagger2</artifactid>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupid>com.github.xiaoymin</groupid>
      <artifactid>swagger-bootstrap-ui</artifactid>
      <version>1.6</version>
    </dependency>

package com.liud.demo.config;

import io.swagger.annotations.apioperation;
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;

/**
 * todo
 * swagger2配置类
 * @author liud
 * @version 1.0
 */

@configuration
@enableswagger2
public class swagger2 {
  //配置swagger2核心配置
  @bean
  public docket createrestapi(){
    return new docket(documentationtype.swagger_2) //指定api类型位swagger2
        .apiinfo(apiinfo())            //用于定义api文档汇总信息
        .select()
        //.apis(requesthandlerselectors.basepackage("com.liud.demo.controller")) //指定生成文档的controller
        //.apis(requesthandlerselectors.any()) //为任何接口生成api文档
        //.apis(requesthandlerselectors.withclassannotation(api.class)) //为有@api注解的controller生成api文档
        .apis(requesthandlerselectors.withmethodannotation(apioperation.class)) //为有@apioperation注解的方法生成api文档
        .paths(pathselectors.any())
        .build();
  }

  //api基本信息
  private apiinfo apiinfo(){
    return new apiinfobuilder()
        .title("springbootdemo的项目接口api") //文档标题
        .contact(new contact("liud", //作者
            "",
            "")) //联系人
        .description("springbootdemo的项目接口api")//详细信息
        .version("1.0.0")//文档版本号
        .termsofserviceurl("")//网站地址
        .build();
  }
}

package com.liud.demo.controller;

import com.liud.demo.service.helloservice;
import io.swagger.annotations.api;
import io.swagger.annotations.apioperation;
import io.swagger.annotations.apiparam;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.beans.factory.annotation.value;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.httpservletrequest;

/**
 * todo
 *
 * @author liud
 * @version 1.0
 */
@restcontroller
@api(tags = {"hello操作接口"})
public class hellocontroller {
  @apioperation(value = "根据用户名获取用户信息接口")
  @requestmapping(value = "/getuserinfo",method = requestmethod.post)
  public string getuserinfo(httpservletrequest request,
               @apiparam(name="username",value = "用户名",required = true) string username){
    return "输入的姓名："+username+",这个用户的信息已经存在！";
  }
}

@apiparam(name="username",value = "用户名",required = true) string username