swagger 接口开发配置

1.pom.xml  加入依赖

	<dependency>
		<groupId>io.springfox</groupId>
		<artifactId>springfox-swagger2</artifactId>
	</dependency>
	<dependency>
		<groupId>io.springfox</groupId>
		<artifactId>springfox-swagger-ui</artifactId>
	</dependency>        

2、创建swagger配置类

package cn.yilixun.jt.cfec.fp.config;

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;

/**
 * SwaggerConfig 配置类.
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * Docket.
     */
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select() // 选择那些路径和api会生成document
                .apis(RequestHandlerSelectors.basePackage("cn.yilixun.jt.cfec.fp"))
                .paths(PathSelectors.any()) // 对所有路径进行监控
                .build()
                 //不使用默认返回状态码
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("名称CFEC FP APIs")
                .description("后台文档接口")
                .contact(new  Contact("易立讯", "", ""))
                .version("1.0")
                .build();
    }
}

package cn.yilixun.jt.cfec.fp.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@EnableWebMvc
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    
    @Value("${swagger.ui.display}")
    private Boolean swaggerUiDisplay = false;
    
    /**
     * 重新指定knife4j静态资源路径.
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        if (swaggerUiDisplay) {
            registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
            registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        }
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
    }

}

application-dev.yml配置文件

swagger:
  ui:
    display: true

3.controller 配置

Swagger使用的注解及其说明：

@Api：用在类上，说明该类的作用。

@ApiOperation：注解来给API增加方法说明。

@ApiImplicitParams : 用在方法上包含一组参数说明。

@ApiImplicitParam：用来注解来给方法入参增加说明。

@ApiResponses：用于表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

    l   code：数字，例如400

    l   message：信息，例如"请求参数没填好"

    l   response：抛出异常的类   

@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

    l   @ApiModelProperty：描述一个model的属性

注意：@ApiImplicitParam的参数说明：

paramType：指定参数放在哪个地方	header：请求参数放置于Request Header，使用@RequestHeader获取 query：请求参数放置于请求地址，使用@RequestParam获取 path：（用于restful接口）-->请求参数的获取：@PathVariable body：（不常用） form（不常用）
name：参数名
dataType：参数类型
required：参数是否必须传	true | false
value：说明参数的意思
defaultValue：参数的默认值

package cn.yilixun.jt.cfec.fp.controller;

import java.text.SimpleDateFormat;
import java.util.Date;

import javax.servlet.http.HttpServletRequest;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import cn.yilixun.fw.common.constant.enums.ResponseCode;
import cn.yilixun.fw.common.constant.enums.ResponseState;
import cn.yilixun.fw.common.util.MethodInvokeUtil;
import cn.yilixun.fw.common.vo.ServiceResultInfo;
import cn.yilixun.fw.common.vo.WebResultInfo;
import cn.yilixun.jt.cfec.common.CfecConstant;
import cn.yilixun.jt.cfec.common.vo.AccountInfo;
import cn.yilixun.jt.cfec.common.vo.ProjectInfo;
import cn.yilixun.jt.cfec.common.vo.UserBaseInfo;
import cn.yilixun.jt.cfec.fp.controller.common.FpCommonController;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

/**
 * PortalController.
 * 
 * @Title:PortalController.java.
 * @Description 免登访问Controller处理.
 **/
@RestController
@RequestMapping("/")
@Api(tags = "账号操作的相关接口")
public class PortalController extends FpCommonController {

    /**
     * 执行登录.
     * 
     * @return 返回登录成功页.
     */
    @RequestMapping(value = "/login.action",method = RequestMethod.POST)
    @ApiOperation("检查学号，密码是否正确的接口")
    @ApiImplicitParams({ @ApiImplicitParam(name = "account", value = "用户名", defaultValue = "",required = true),
            @ApiImplicitParam(name = "password", value = "密码", defaultValue = "", required = true) })
    @ApiResponses({ @ApiResponse(code = 200, message = "成功",response = UserBaseInfo.class),
            @ApiResponse(code = 401, message = "项目",response = ProjectInfo.class)})
    public Object doLogin(HttpServletRequest request, String account, String password) {
        return WebResultInfo.getWrongResponse("login failed!!!!!!");
    }

}

// 配置响应参数名称

@ApiModel(value="用户基本信息vo")
public class UserBaseInfo implements Serializable {

    private static final long serialVersionUID = 5934345279923086367L;

    /* 用户姓名 */
    @Getter
    @Setter
    @ApiModelProperty(value="用户姓名")
    private String userName;
    /* 用户英文名 */
    @Getter
    @Setter
    @ApiModelProperty(value="用户英文名")
    private String userNameEn;
}

4.浏览器访问 http://localhost:8091/fp/swagger-ui.html    ==> 网址/swagger-ui.html