一個基於Spring極度簡單的Restful API工具
阿新 • • 發佈：2021-09-15
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
publicclassDemoApplication{
publicstaticvoidmain(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就可以除錯介面了。