spring.boot.sapi.starter

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

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

<dependency>
  <groupId>com.github.xiaour</groupId>
  <artifactId>xiaour.springboot.sapi.starter</artifactId>
  <version>1.4</version>
</dependency>

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上传文件。

标签：输出,SAPI,接口,controllers,API,V1.4,注解,com
来源： https://www.cnblogs.com/baimeishaoxia/p/12760393.html