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

时间:2021-09-15
本文章向大家介绍一个基于Spring极度简单的Restful API工具,主要包括一个基于Spring极度简单的Restful API工具使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

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

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

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

<dependency>
   <groupId>com.github.xiaour</groupId>
   <artifactId>xiaour.springboot.sapi.starter</artifactId>
   <version>1.0</version>
   <scope>system</scope>
   <systemPath>${project.basedir}/libs/xiaour.springboot.sapi.starter-1.0.jar</systemPath>
</dependency>

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就可以调试接口了。

 

原文地址:https://www.cnblogs.com/cqqfboy/p/15271620.html