转自:
springboot如何整个Swagger呢?
下文笔者讲述springboot整个swagger的方法分享,如下所示
springboot整个swagger的步骤
步骤1:引入jar包
io.springfox springfox-swagger2 2.5.0 io.springfox springfox-swagger-ui 2.5.0
swagger2的配置文件设置
package com.java265.spring;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 Swagger2 {//swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//为当前包路径.apis(RequestHandlerSelectors.basePackage("com.java265")).paths(PathSelectors.any()).build();}//构建 api文档的详细信息函数,注意这里的注解引用的是哪个private ApiInfo apiInfo() {return new ApiInfoBuilder()//页面标题.title("Spring Boot 测试使用 Swagger2 构建RESTful API")//创建人.contact(new Contact("java265", "http://www.java265.com", ""))//版本号.version("2.0")//描述.description("API 描述").build();}
}
controller编写
package com.java265.spring.controller;import com.java265.spring.model.User;
import com.java265.spring.service.UserService;
import io.swagger.annotations.Api;import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("api")
@Api("swaggerDemoController相关的api")
public class SwaggerDemoController {@Autowiredprivate UserService userService;private static final Logger logger= LoggerFactory.getLogger(SwaggerDemoController.class);@ApiOperation(value = "使用id查询用户信息", notes = "从数据库中查询用户信息")@ApiImplicitParam(name = "id", value = "UserID", paramType = "path", required = true, dataType = "Long")@RequestMapping(value = "/{id}", method = RequestMethod.GET)public User getStudent(@PathVariable Long id) {logger.info("查询用户信息");return userService.selectByPrimaryKey(id);}
}
使用以上方式就可实现swagger2与springboot就集成完毕了 访问http://localhost:8080/swagger-ui.html