springboot如何整个Swagger呢？

转自:

下文笔者讲述springboot整个swagger的方法分享，如下所示

springboot整个swagger的步骤

步骤1:引入jar包

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

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

springboot如何整个Swagger呢？相关推荐

lombok标签_微服务之：springboot入门、Swagger、Lombok使用
0x01.第一个Springboot程序项目启动注解:@springbootApplication @SpringBootApplication public class HellobootAppl ...
JAVA使用Springboot+MP+VUE+Swagger前后端分离进行微信支付
1.微信支付流程图官方文档流程图这里根据自己的理解画的图 2.后端代码 2.1依赖的引入 springboot工程创建这里我创建的是springboot工程导入的工具类有Lombok.Sprin ...
SpringBoot整合knife4j(swagger)实现前后端分离可视化接口调试与接口测试
目录 1.为什么使用Knife4j 2.基本使用 2.1 pom 2.2 配置Knife4j分组 2.3 拦截器放行 2.4 实体类 2.5 SpringBoot整合基础使用 2.5.1 基础配置 2 ...
SpringBoot之整合Swagger(页面无法显示)
问题: 配置Swagger后,访问http://localhost:8080/swagger-ui.html不显示页面原因:Swagger版本过高我尝试降低springboot版本到2.2.6.R ...
开发完成的springboot项目扩展 swagger
第一步:pom.xml 引入 swagger 配置 <swagger.version>2.9.2</swagger.version> <!--swagger start- ...
springboot快速集成swagger
今天技术总监说:小明,我们本次3.0改造,使用swagger2.0作为前后端分离的接口规范,它可以一键生成前后端的API,一劳永逸--小明:??? Spring Boot 框架是目前非常流行的微服务框 ...
【SpringBoot】集成swagger
1.引入依赖  <dependency><groupId>io.springfox</groupId><artifac ...
springboot项目使用swagger时拦截器需要放开哪些URL
1.如果不设置会导致swagger主页无法访问 2.以下url不需要拦截 /swagger-resources/*, /swagger-ui.html,/v2/api-docs, /webjars/s ...
Springboot项目集成Swagger
官网:https://swagger.io 一.准备工作 1). 导入knife4j的maven坐标 <dependency><groupId>com.github.xiaoy ...

springboot如何整个Swagger呢？

springboot如何整个Swagger呢？相关推荐

最新文章

热门文章