zfs-api-administration

專案介紹

api 文件管理系統

使用教程

• 引入依賴

<dependency>
    <groupId>cn.zhangfusheng</groupId>
    <artifactId>zfs-api-administrator-core</artifactId>
    <version>1.0.0</version>
</dependency>

• 配置包掃描路徑以及生成文件介面

@Configuration
@ComponentScan("cn.zhangfusheng.api.rest") // API介面的路徑,固定寫法
public class ZfsApiConfig implements CommandLineRunner {
    // CommandLineRunner 是spring boot專案提供的預先載入的介面
    @Override
    public void run(String... args) throws Exception {
        // 初始化介面文件的掃描路徑
        // 方式一: 掃描一個單獨的路徑
        cn.zhangfusheng.api.config.ZfsApiConfig.initZfsApiConfig("cn.zfs.swagger.ui");
        // 方式二: 分組掃描,多個路徑
        HashMap<String, String> groupPackageMap = new HashMap<>();
        groupPackageMap.put("one","cn.zfs.swagger.ui.one.controller");
        groupPackageMap.put("two","cn.zfs.swagger.ui.two.controller");
        groupPackageMap.put("three","cn.zfs.swagger.ui.three.controller");
        cn.zhangfusheng.api.config.ZfsApiConfig.initZfsApiConfig(groupPackageMap);
    }
}
 

• 註解使用說明

@ClassAnnotation
    描述: 作用於類上的註解,掃描該類下的介面
    屬性:
        name    string  名稱
        group   string  分組  暫時沒用
        desc    string  描述
        hidden  Boolean 是否隱藏   
        path    string  請求路徑 
@MethodAnnotation
    描述: 作用於方法的註解,掃描該方法,前提是該方法所屬的類上添加了@ClassAnnotation註解
    屬性:
        desc    string  方法的行為描述
        method  string  請求方式
       hidden  Boolean 是否隱藏   
       path     string  請求路徑
       ParameterAnnotation 請求引數註解
@ParameterAnnotation
    描述: 引數列表掃描註解
    屬性:
        name    string 引數名稱
        desc    string  引數描述
        defaultValue    string 預設值
        type    class   引數型別
        required    Boolean 是否必填
 

• 下載客戶端並啟動

# 從maven倉庫下載jar包
http://central.maven.org/maven2/cn/zhangfusheng/zfs-api-administrator-ui/1.0.0/zfs-api-administrator-ui-1.0.0.jar

# 從碼雲上下載客戶端
git clone https://gitee.com/fushengruomengzhang_admin/zfs-api-administration.git
cd zfs-api-administration
mvn clean install
cd  zfs-api-administrator-ui/target

java -jar zfs-api-administrator-ui-1.0.0.jar --server.port=8080 

 

• 訪問API文件

訪問: localhost:8080/zfs-api-ui.html

• 頁面的具體使用參考連結

https://blog.csdn.net/qq_33547169/article/details/83275389