SAPI 基於Spring極度簡單的Restful API工具

SAPI是一個及其精簡的Restful API輸出工具,誕生的背景是基於目前微服務開發接口,不少中小型項目開發人員在對接口測試時不只須要使用JUnit等進行業務接口測試,還須要對API進行自測。因此SAPI很好的解決了開發人員須要一個一個參數的往接口測試工具填寫調試的反覆過程。git

目前SAPI只須要開發人員引入stater後再啓動類加入一行文件便可。下面咱們直接看看使用時是什麼樣的。github

1.在pom.xml中配置以下,其餘倉庫請打開連接自行選擇配置spring

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

2.啓動類加入註解Sapi和ServletComponentScanapi

@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?springboot

啓動項目後在瀏覽器打開地址 http://127.0.0.1:{服務端口}/{如有項目路徑}/sapi 便可打開Sapi的接口列表頁面;每一個接口上都有一個綠色的運行按鈕,點擊運行按鈕就會彈出接口詳細內容頁面(以下圖)。點擊Send就能夠調試接口了。
maven

好啦,各位能夠當即使用sapi了,祝各位使用愉快微服務

也歡迎你們訪問個人Git託管項目或Star工具

相關文章
相關標籤/搜索