资讯专栏INFORMATION COLUMN

SAPI V1.4发布,轻巧的API输出测试组件

Dogee / 388人阅读

摘要:一个简单的输出工具,只需简单配置,即可将接口中的所有接口及参数全部以结构化的方式输出的页面上。新增支持文件类型的数据。优化了返回结果格式化的问题。改版了界面列表展示部分,修复了扫描不到的情况。增加了对的支持支持上传文件。

spring.boot.sapi.starter

一个简单的API输出工具,只需简单配置,即可将接口中的所有API接口及参数全部以结构化的方式输出的页面上。
基于SpringMvc或Springboot的接口管理工具

1.下载并打包Jar配置好POM


  com.github.xiaour
  xiaour.springboot.sapi.starter
  1.4

2.启动类加入注解@Sapi.
controllers属性可以声明多个,如controllers = {"com.example.demo.ctrl","com.example.demo2.ctrl"},controllers的路径对应项目中controller所在的路径。enable是SAPI的开关,如果需要上生产环境只需要enable=false就可以了,这样避免在生产暴露接口。

@Sapi(controllers = {"com.example.demo.ctrl"})
@SpringBootApplication
public class DemoApplication {

   public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }
}

3.Controller类加入注解@SapiGroup(title="").
SapiGroup是用于分组输出的注解,可以在上面加入中文接口注释,该注解可有可无,如不注解,默认输出的是当前类名。

@SapiGroup(title = "小猫管理")
@RestController
@RequestMapping("/cat")
public class CatController {
    
}

4.项目启动后会在控制台输出一条SAPI的URL,打开就可以看到相关的API了,下面是一个打开后的演示界面。快快测试你的API吧!

目前项目在Github和码云都有开源,欢迎Star或fork
https://github.com/xiaour/spr...
https://gitee.com/xiaour/spri...

版本功能

当前为1.4版本,实现了输出接口URL和参数,分组输出接口;

2.0版本将实现添加接口说明、历史版本接口管理

更新日志

20180621.页面上提供了POST和GET测试。

20180628.新增支持文件类型的数据。

20180702.新增支持自定义请求Header。

20180710.新增了接口分页。

20180828.优化了返回结果格式化的问题。

20180907.改版了界面列表展示部分,修复了Class扫描不到的情况。

20180912.增加了对RequestBody的支持,支持MultipartFile上传文件。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/77113.html

相关文章

  • SAPI 基于Spring极度简单Restful API工具

    摘要:是一个及其精简的输出工具,诞生的背景是基于目前微服务开发接口,很多中小型项目开发人员在对接口测试时不仅需要使用等进行业务接口测试,还需要对进行自测。目前只需要开发人员引入后再启动类加入一行文件即可。中的路径不要忽略。 SAPI是一个及其精简的Restful API输出工具,诞生的背景是基于目前微服务开发接口,很多中小型项目开发人员在对接口测试时不仅需要使用JUnit等进行业务接口测试,...

    Keven 评论0 收藏0
  • PHP底层工作原理

    摘要:因此,我们需要性能优异的引擎合适的车轮正确的跑道三架构从下往上四层属于操作系统的底层服务器,属于次服务器,沟通和属于服务端编程语言,通过模块和关联和其他服务属于应用服务,通过的外挂模块和关联参考文档底层工作原理 一、简介 PHP总共有三个模块:内核、Zend引擎、以及扩展层 PHP内核用来处理请求、文件流、错误处理等相关操作 Zend引擎(ZE)用以将源文件转换成机器语言,然后在虚拟...

    mumumu 评论0 收藏0
  • 前后端完全分离之 API 设计

    摘要:删除后指定产品不存在获取商品列表未分页获取全部商品成功系列的表壳材料为轻巧的银色及深空灰色阳极氧化铝金属,强化玻璃材质为显示屏提供保护。外观设计不再棱角分明,表层玻璃边有一个弧度向下延伸,与阳极氧化铝金属机身边框衔接。 背景 API 就是开发者使用的界面。我的目标不仅是能用,而且好用,跨平台(PC, Android, IOS, etc...)使用。本文将详细介绍 API 的设计及异常处...

    gitmilk 评论0 收藏0
  • 前后端完全分离之 API 设计

    摘要:删除后指定产品不存在获取商品列表未分页获取全部商品成功系列的表壳材料为轻巧的银色及深空灰色阳极氧化铝金属,强化玻璃材质为显示屏提供保护。外观设计不再棱角分明,表层玻璃边有一个弧度向下延伸,与阳极氧化铝金属机身边框衔接。 背景 API 就是开发者使用的界面。我的目标不仅是能用,而且好用,跨平台(PC, Android, IOS, etc...)使用。本文将详细介绍 API 的设计及异常处...

    gaara 评论0 收藏0

发表评论

0条评论

Dogee

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<