正文 

当前位置： 首页 > java > java教程

(二十二)atp应用测试平台——swagger2集成swagger-bootstrap-ui实现api文档访问(代码片段)

北溟溟 北溟溟     2023-04-03     638

关键词：

前言

原生的swagger文档虽然也可以作为API文档输出，但是不够简洁优美，本节内容我们介绍一下swagger-bootstrap-ui组件，实现对swagger API文档的二次封装，使用API文档更加简洁明了，无论是入参还是结果响应，都有清晰的说明，而且可以保留缓存，方便刷新文档后继续保留之前的操作。需要注意的是该组件目前只支持swagger2，swagger3目前还不兼容。

正文

①导入swagger2的pom依赖

<!-- Swagger2核心包-->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<!-- Swagger2 UI包，前端展示API文档 -->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>

②导入swagger-bootstrap-ui组件

<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>swagger-bootstrap-ui</artifactId>
	<version>1.9.6</version>
</dependency>

③ swagger启动配置

@Configuration
@EnableSwagger2
public class Swagger2Config 
    @Bean
    public Docket createRestApi() 
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build()
                .enable(true);
    

    private ApiInfo apiInfo() 
        return new ApiInfoBuilder()
                .title("HT-ATP测试平台")
                .description("编程也可以很快乐！！！")
                .contact(new Contact("", "", ""))
                .version("1.0")
                .build();

④创建api访问接口示例

@Api(tags = "app管理")
@RestController
@RequestMapping("/app")
@Slf4j
public class AppController 
    @Autowired
    private AppService appService;

    @ApiOperation(value = "app应用列表查询")
    @GetMapping(value = "page")
    public Result<Page<App>> page(@ApiParam(name = "pageNum", value = "当前页")
                                  @RequestParam(value = "pageNum") Integer pageNum,
                                  @ApiParam(name = "pageSize", value = "每页记录数")
                                  @RequestParam(value = "pageSize") Integer pageSize) 
        IPage ipage = new Page<>().setCurrent(pageNum).setSize(pageSize);
        IPage page = appService.page(ipage);
        return Result.success(page);

⑤启动项目，访问服务地址http://127.0.0.1:7777/doc.html，查看API接口文档

⑥ 查看入参的API接口文档

⑦查看出参的API接口文档

 ⑧测试结果，包括响应码，耗时，大小等信息

结语

关于swagger2集成swagger-bootstrap-ui实现API文档访问的内容到这里就结束了，下期见。。。

(二十一)atp应用测试平台——vue实战之大红灯笼高高挂(代码片段)

前言2022年的最后一天班，好的开始，好的结束。把大红灯笼高高挂起来，欢度元旦的到来，兔年的到来。明年再战。明年再见。。。 正文正菜奉上lantern.vue灯笼源码<template><divclass="app"><divclass... 查看详情

(二十一)atp应用测试平台——vue实战之大红灯笼高高挂(代码片段)

前言2022年的最后一天班，好的开始，好的结束。把大红灯笼高高挂起来，欢度元旦的到来，兔年的到来。明年再战。明年再见。。。 正文正菜奉上lantern.vue灯笼源码<template><divclass="app"><divclass... 查看详情

(二十四)atp应用测试平台——springboot集成fastdfs上传与下载功能(代码片段)

前言本节内容我们主要介绍一下如何在springboot项目中集成fastdfs组件，实现文件的上传与下载。关于fastdfs服务中间键的安装过程，本节内容不做介绍。fastdfs是一个轻量级的分布式文件系统，也是我们文件存储中常常... 查看详情

(十四)atp应用测试平台——使用docker-compose一键式安装atp应用测试平台的依赖服务(代码片段)

前言关于ATP应用服务测试平台的相关内容已经更新不少，下载项目的小伙伴第一时间一定是想着怎么把这个平台项目跑起来，看下小编花里胡哨的效果是否能正常show。不过由于依赖的增多，项目的服务也随之多了起... 查看详情

(十八)atp应用测试平台——关于springboot应用监控的那些事(代码片段)

...快告诉我你的绝招。本节内容我们主要介绍一下springboot应用的常见应用参数监控指标，从而更好的关注springboot应用的运行状况并实现应用的监控。除此之外，我们通过集成一 查看详情

(十八)atp应用测试平台——关于springboot应用监控的那些事(代码片段)

...快告诉我你的绝招。本节内容我们主要介绍一下springboot应用的常见应用参数监控指标，从而更好的关注springboot应用的运行状况并实现应用的监控。除此之外，我们通过集成一 查看详情

atp应用测试平台——关于axios的配置使用(代码片段)

前言该篇是应某个粉丝的要求讲解一下关于axios请求组件的使用，其实axios组件类似我们以前使用过的jQuery中的ajax组件，都是用于进行http网络请求的组件。axios组件在前后端分离项目中使用的更加广泛，也更易集成... 查看详情

跨平台应用开发进阶(二十二)：uni-appandroidapp上线准备工作汇总(代码片段)

文章目录一、为什么要做安全加固？二、如何为App应用加固？三、APP签名3.1使用说明3.2V1、V2、V3、V4签名方案3.2.1v1签名3.2.2v2签名3.2.3v2签名相对v1签名的优点3.2.4v3签名3.2.5v4签名3.2.6总结3.3jarsigner与apksigner3.3.1jarsigner3.3.2apksi... 查看详情

(十三)atp应用测试平台——springboot集成kafka案例实战(代码片段)

前言kafka消息中间键也是我们经常要用到的功能，尤其是在大数据、高并发的项目中，如日志收集、业务数据分发等等。其最核心的俩大功能作用是:①削峰填谷②异步解耦。本节我们主要介绍一下如何在springboot项目中集... 查看详情

atp应用测试平台——关于网页表格的打印及pdf下载的实战案例(代码片段)

前言在网站应用中，我们可能会有这样一个需求，将网页的部分内容，例如表格，网页片段下载打印或者导出PDF，本小节内容正是关于这样一个内容的实战，基于vue2环境开发，希望能够帮助到你。源码... 查看详情

atp应用测试平台——关于vue-router前端路由的配置使用案例(代码片段)

前言VueRouter是Vue.js(opensnewwindow)官方的路由管理器。它和Vue.js的核心功能深度集成，功能丰富，是我们构建vue前端项目中必不可少的的组件之一，本节我们简单介绍一下在vue项目中如何使用vue-router组件实现页面的路由... 查看详情

jmeter（二十二）：内存溢出原因及解决方法

jmeter是一个java开发的开源性能测试工具，在性能测试中可支持模拟并发压测，但有时候当模拟并发请求较大或者脚本运行时间较长时，压力机会出现卡顿甚至报异常————内存溢出，这里就介绍些如何解决内存溢出及相关的... 查看详情

atp应用测试平台——关于vue中vue-quill-editormavon-editortinymce等多种富文本编辑器的集成使用(代码片段)

...or以及tinymce等的集成及使用。源代码依然托管在我们的ATP应用测试平台中，源码地址：https://gitee.com/northcangap/atp，仅供参考使用。富文本编辑器实现效果如下： 查看详情

atp应用测试平台——使用bat批处理实现springboot项目的启动与关闭(代码片段)

...停，并且自行配置java环境，这对于windows环境的单应用而言，批处理文件更加简洁，同时也可以实现开机 查看详情

atp应用测试平台——使用easyexcel实现excel导入导出多sheet填充模板下载等功能案例实战(代码片段)

前言Java开发中实现Excel的导入、导出、填充、多sheet页操作等常用功能也是我们经常要面对的开发需求，本文以easyexcel为例，将excel中的常用功能整理成一个个小案例，参考使用。案例源码地址：https://gitee.com/northc... 查看详情

(十七)atp应用测试平台——自定义实现一个springboot2的线程池启动器starter

前言启动器是springboot的一大特点，我们可以根据项目自身需求按需装配我们的组件。例如我们需要操作redis，项目中可以添加一个redis的启动器spring-boot-starter-data-redis，这样redis的一些客户端操作功能我们就集成好了&#... 查看详情

(十七)atp应用测试平台——自定义实现一个springboot2的线程池启动器starter(代码片段)

前言启动器是springboot的一大特点，我们可以根据项目自身需求按需装配我们的组件。例如我们需要操作redis，项目中可以添加一个redis的启动器spring-boot-starter-data-redis，这样redis的一些客户端操作功能我们就集成好了&#... 查看详情

(十九)atp应用测试平台——springboot集成rocketmq案例实战(代码片段)

前言本节内容是关于RocketMQ消息中间键的实战内容，主要介绍在springboot项目中如何集成使用RocketMQ消息中间键，包括消息的发送、消息的接收以及RocketMQ的一些配置说明，以及效果说明。话不多说，开始实战内容。... 查看详情