在springboot集成Swagger-knife4j接口文档

pom.xml配置依赖

    <dependencies><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.49</version></dependency><dependency><groupId>io.swagger</groupId><artifactId>swagger-annotations</artifactId><version>1.5.22</version><scope>compile</scope></dependency><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>2.0.4</version></dependency></dependencies>

SwaggerConfig

package com.zm.web.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;@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket login() {return docket("测试", "com.zm.web.controller");}public Docket docket(String groupName, String basePackage) {return new Docket(DocumentationType.SWAGGER_2).groupName(groupName).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage(basePackage)).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("title").description("description").license("license").licenseUrl("licenseUrl").termsOfServiceUrl("termsOfServiceUrl").contact(new Contact("name", "url", "email")).version("version").build();}
}

HttpConverterConfig

package com.zm.web.Config;import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;@Configuration
@EnableWebMvc
public class HttpConverterConfig implements WebMvcConfigurer {@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}//使用阿里 FastJson 作为JSON MessageConverter@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) {FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();List<MediaType> supportedMediaTypes = new ArrayList<>();supportedMediaTypes.add(MediaType.APPLICATION_JSON);supportedMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);supportedMediaTypes.add(MediaType.APPLICATION_ATOM_XML);supportedMediaTypes.add(MediaType.APPLICATION_FORM_URLENCODED);supportedMediaTypes.add(MediaType.APPLICATION_OCTET_STREAM);supportedMediaTypes.add(MediaType.APPLICATION_PDF);supportedMediaTypes.add(MediaType.APPLICATION_RSS_XML);supportedMediaTypes.add(MediaType.APPLICATION_XHTML_XML);supportedMediaTypes.add(MediaType.APPLICATION_XML);supportedMediaTypes.add(MediaType.IMAGE_GIF);supportedMediaTypes.add(MediaType.IMAGE_JPEG);supportedMediaTypes.add(MediaType.IMAGE_PNG);supportedMediaTypes.add(MediaType.TEXT_EVENT_STREAM);supportedMediaTypes.add(MediaType.TEXT_HTML);supportedMediaTypes.add(MediaType.TEXT_MARKDOWN);supportedMediaTypes.add(MediaType.TEXT_PLAIN);supportedMediaTypes.add(MediaType.TEXT_XML);converter.setSupportedMediaTypes(supportedMediaTypes);converter.setDefaultCharset(Charset.forName("UTF-8"));FastJsonConfig config = new FastJsonConfig();JSON.DEFFAULT_DATE_FORMAT = "yyyy-MM-dd HH:mm:ss";config.setSerializerFeatures(SerializerFeature.WriteDateUseDateFormat);//格式化时间converter.setFastJsonConfig(config);converters.add(converter);}}

API统一回调

package com.zm.common.util;import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;@ApiModel
public class ApiResult<T> implements Serializable {@ApiModelProperty(value = "回调数据")private T data;@ApiModelProperty(value = "版本号")private String vision;@ApiModelProperty(value = "状态码")private String code;@ApiModelProperty(value = "消息提示")private String msg;@ApiModelProperty(value = "数据结果集")public T getData() {return data;}public String getVision() {return vision;}public String getCode() {return code;}public String getMsg() {return msg;}public ApiResult<T> setData(T data) {this.data = data;return this;}public ApiResult<T> setVision(String vision) {this.vision = vision;return this;}public ApiResult<T> setCode(String code) {this.code = code;return this;}public ApiResult<T> setMsg(String msg) {this.msg = msg;return this;}/*** @Description    成功回调* @param data     回调数据* @param vision   版本号* @return*/public static ApiResult successMsg(Object Object, String vision) {return new ApiResult().setCode("200").setMsg("scuess").setData(Object).setVision(vision);}}

API接收或者返回的具体类

package com.zm.entity;import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel
public class User {@ApiModelProperty(value = "id")private Integer id;@ApiModelProperty(value = "姓名")private String name;@ApiModelProperty(value = "年龄")private Integer age;@ApiModelProperty(value = "爱好")private String skill;@ApiModelProperty(value = "评价")private String evaluate;@ApiModelProperty(value = "成绩")private Integer fraction;}

API层

package com.zm.web.controller;import com.zm.common.util.ApiResult;
import com.zm.entity.User;
import com.zm.service.UserService;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;@RestController
public class HelloController {@Autowiredprivate UserService userService;@PostMapping("/hello")@ApiOperation(value = "hello" ,httpMethod = "POST")public ApiResult<User> hello(@RequestBody User userVo) {System.out.println("请求参数："+userVo);User 小明 = userService.selectUserInfoByName("小明");return ApiResult.successMsg(小明,"1");}}

启动项目，访问地址http://127.0.0.1:8080/doc.html