五：Java+SpringBoot集成SwaggerUI

1.SwaggerUI的简单介绍
Swagger是一个Restful风格接口的文档在线自动生成和测试的框架
官网：http://swagger.io
官方描述：The World’s Most Popular Framework for APIs.
页面UI如下：
demo内的接口，已在之前的文章中介绍过，有兴趣的同学可以自己看一看：
https://editor.csdn.net/md?not_checkout=1&articleId=122317433

https://editor.csdn.net/md?not_checkout=1&articleId=122317555

https://editor.csdn.net/md?not_checkout=1&articleId=122317610

2.pom文件配置
在pom.xml文件中，引入swagger的包

    <properties><swagger.version>2.6.1</swagger.version></properties><dependencies><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>${swagger.version}</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>${swagger.version}</version></dependency></dependencies>

3.新建配置文件
在main/java目录下，新建com.course.config目录以存放配置文件，然后新建SwaggerConfig。

配置内容如下：

@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket api(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).pathMapping("/").select().paths(PathSelectors.regex("/.*")).build();}private ApiInfo apiInfo(){return new ApiInfoBuilder().title("我的接口文档").contact(new Contact("Lyn","","326030434@qq.com")).description("这是SwaggerUi生成的接口文档").build();}
}

4.给接口加上注解
首先要在整个类前面加上

@Api(value = "/",description = "这是所有get方法")

然后在每个接口前加上

@ApiOperation(value = "通过这个方法可以获取到cookies",httpMethod = "GET")

在这里，以/getcookies接口举例，完整代码如下

@RestController
@Api(value = "/",description = "这是所有get方法")
public class MyGetMethod {@RequestMapping(value = "/getcookies",method = RequestMethod.GET)@ApiOperation(value = "通过这个方法可以获取到cookies",httpMethod = "GET")public String getCookies(HttpServletResponse response){//HttpServletRequest  装请求信息的类//HttpServletResponse  装相应信息的类Cookie cookie = new Cookie("login","true");response.addCookie(cookie);return "恭喜获得cookies信息成功";}
}

5.修改Application文件
之前是@ComponentScan(“com.course.server”)并没有包含到com.course.config文件，所以，这里修改为@ComponentScan(“com.course”)

@SpringBootApplication
@ComponentScan("com.course")
public class Application {public static void main(String[] args){SpringApplication.run(Application.class,args);}
}

6.查看接口文档
Rerun Application文件，然后浏览器访问http://localhost:9527/swagger-ui.html
到这里SwaggerUI的集成就完成了！

五：Java+SpringBoot集成SwaggerUI相关推荐

SpringBoot集成Swaggerui及问题解决
目前在做前后台分离项目的后台接口部分,故在springboot中引入了swaggerui来做restful接口测试.本文首先描述springboot集成swaggerui的过程,其次,讲述本人在集成过 ...
SpringBoot集成swagger-ui以及swagger分组显示
文章目录 1.swagger配置类 2.使用swagger 3.额外的学习经历大家好,这篇文章展示下如何在springboot项目中集成swagger-ui.有人说,这都是老生常谈,网上的例子数不胜 ...
SpringBoot集成SwaggerUI
1.SwaggerUI的简单介绍 Swagger是一个Restful风格接口的文档在线自动生成和测试的框架官网:http://swagger.io 官方描述:The World's Most Pop ...
java SpringBoot 集成阿里云视频直播完成直播功能
经历了几天的周折,近期才把项目完成,在这里与大家分享一下踩坑之路,也方便日后有类似项目,可以借阅一番开发直播前先满足已下条件 1.开通视频直播功能 2.购买好了OSS存储 3.购买两个域名并且备案好 ...
Java SpringBoot集成阿里云短信与邮件服务
1.pom.xml导入jar包 <dependency><groupId>com.aliyun</groupId><ar ...
java SpringBoot 集成阿里云视频直播完成直播功能
经历了几天的周折,近期才把项目完成,在这里与大家分享一下踩坑之路,也方便日后有类似项目,可以借阅一番该项目是一个H5直播,采用m3u8格式完成直播的展示.通过推流地址,借助第三方推流工具实现直播效果 ...
springboot系列十五、springboot集成PageHelper
一.介绍项目中经常会遇到分页,PageHelper为我们解决了这个问题.本质上实现了Mybatis的拦截器,作了分页处理. 二.配置PageHelper 1.引入依赖 pagehelper-spri ...
SpringBoot集成SwaggerUI及其使用
撸了今年阿里.头条和美团的面试,我有一个重要发现.......>>> 本文永久更新地址:https://my.oschina.net/bysu/blog/3092623 推荐一款免费 ...
Java SpringBoot 集成微信公众号
微信公众号申请公众号引入依赖 yml配置读取配置文件类WxMaProperties 配置文件加载 json返回工具类控制层测试号配置以上就完成了哦,简单教程 Gitee开源地址申请公众号 ...

五：Java+SpringBoot集成SwaggerUI

五：Java+SpringBoot集成SwaggerUI相关推荐

最新文章

热门文章