资讯专栏INFORMATION COLUMN

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

Keven / 1923人阅读

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

SAPI是一个及其精简的Restful API输出工具,诞生的背景是基于目前微服务开发接口,很多中小型项目开发人员在对接口测试时不仅需要使用JUnit等进行业务接口测试,还需要对API进行自测。所以SAPI很好的解决了开发人员需要一个一个参数的往接口测试工具填写调试的反复过程。

目前SAPI只需要开发人员引入stater后再启动类加入一行文件即可。下面我们直接看看使用时是什么样的。

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


   com.github.xiaour
   xiaour.springboot.sapi.starter
   1.0
   system
   ${project.basedir}/libs/xiaour.springboot.sapi.starter-1.0.jar

2.启动类加入注解Sapi和ServletComponentScan

@Sapi(controllers = {"com.example.demo.ctrl","com.example.demo.ctrl2"})
@ServletComponentScan(basePackages = {"com.github.xiaour.api_scanner.servlet"})
@ComponentScan
@SpringBootApplication
public class DemoApplication {

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

这里说明一下Sapi的controllers是当前项目中需要被输入API的Controller路径,有多个的话配置多个即可。ServletComponentScan中的com.github.xiaour.api_scanner.servlet路径不要忽略。到这里我们的配置几乎就全部完成了。怎么样?是不是相当简单了。

3.如何使用Sapi?

启动项目后在浏览器打开地址 http://127.0.0.1:{服务端口}/{若有项目路径}/sapi 即可打开Sapi的接口列表页面;每个接口上都有一个绿色的运行按钮,点击运行按钮就会弹出接口详细内容页面(如下图)。点击Send就可以调试接口了。

好啦,各位可以立即使用sapi了,祝各位使用愉快

也欢迎大家访问我的Git托管项目或Star

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

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

相关文章

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

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

    Dogee 评论0 收藏0
  • 后端API从入门到放弃指北

    摘要:菜鸟教程框架中文手册入门目标使用搭建通过对数据增删查改没了纯粹占行用的拜 后端API入门学习指北 了解一下一下概念. RESTful API标准] 所有的API都遵循[RESTful API标准]. 建议大家都简单了解一下HTTP协议和RESTful API相关资料. 阮一峰:理解RESTful架构 阮一峰:RESTful API 设计指南 RESTful API指南 依赖注入 D...

    Jeffrrey 评论0 收藏0
  • 后端API从入门到放弃指北

    摘要:菜鸟教程框架中文手册入门目标使用搭建通过对数据增删查改没了纯粹占行用的拜 后端API入门学习指北 了解一下一下概念. RESTful API标准] 所有的API都遵循[RESTful API标准]. 建议大家都简单了解一下HTTP协议和RESTful API相关资料. 阮一峰:理解RESTful架构 阮一峰:RESTful API 设计指南 RESTful API指南 依赖注入 D...

    sf190404 评论0 收藏0
  • 后端API从入门到放弃指北

    摘要:菜鸟教程框架中文手册入门目标使用搭建通过对数据增删查改没了纯粹占行用的拜 后端API入门学习指北 了解一下一下概念. RESTful API标准] 所有的API都遵循[RESTful API标准]. 建议大家都简单了解一下HTTP协议和RESTful API相关资料. 阮一峰:理解RESTful架构 阮一峰:RESTful API 设计指南 RESTful API指南 依赖注入 D...

    Airmusic 评论0 收藏0

发表评论

0条评论

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