Springboot中使用Swagger2构建RESTfulAPIs

变态的问题&＃xff1a;在一台电脑上

context-path 不能是根

这里设置context

application.properties

server.servlet.context-path&＃61;/jk

1、pom.xml

增加

io.springfoxspringfox-swagger22.9.2

io.springfoxspringfox-swagger-ui2.9.2


2、配置

SwaggerConfig.java

package com.example.demo.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;/*** &＃64;author yujikuan*/
&＃64;EnableSwagger2
&＃64;Configuration
public class SwaggerConfig {&＃64;Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Springboot 中使用Swagger2构建RESTful APIs").termsOfServiceUrl("https://blog.csdn.net/qq_26229005/article/details/103843497").description("springmvc swagger2").contact(new Contact("yujikuan", "https://blog.csdn.net/qq_26229005/article/details/103843497", "329656576&＃64;qq.com")).version("1.1").build();}
}

Controller

package com.example.demo.controller;import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.*;&＃64;RestController
&＃64;RequestMapping("/api")
&＃64;Api(value &＃61; "api接口", description&＃61;"用户相关操作")
&＃64;Slf4j
public class ApiController {&＃64;RequestMapping(value &＃61; "/user")&＃64;ApiOperation(value &＃61; "用户查询服务", notes &＃61; "根据传过来的user_id来查询用户")&＃64;ResponseBody
//注释声明 RequestParampublic User getUserById(&＃64;ApiParam(value &＃61; "用户id") &＃64;RequestParam String user_id){/* User user &＃61; userService.getUserById(user_id);map.put("user", user);*/log.info("userid&＃61;"&＃43;user_id);User user&＃61;new User();user.setUser_id(user_id);user.setUser_name("于吉宽");user.setPassword("dsfsfs&＃64;ddd");return user;}}


实体类型

package com.example.demo.controller;import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;&＃64;ApiModel(value &＃61; "用户")public &＃64;Data class User {private String user_id;&＃64;ApiModelProperty(value &＃61; "用户名")private String user_name;&＃64;ApiModelProperty(value &＃61; "密码")private String password;
}


最后启动项目

访问http://localhost:8080/jk/swagger-ui.html#/

如果报curl错误&＃xff0c;请https://curl.haxx.se/download.html#Win64 下载&＃xff0c;配置相关环境变量既可。

参考

http://springfox.github.io/springfox/docs/current/#introduction