介面檔案是專案開發中必需的說明檔案,介面檔案撰寫有很多不同的方式,今天本文簡單介紹一下常用的幾種介面檔案撰寫方法,
API 檔案匯入生成
使用介面檔案工具 Eolink 演示 API 檔案匯入生成的程序, Eolink 系統提供一鍵匯入 Swagger 、 Postman 、 RAP 、 YAPI 等產品資料的功能,實作無負擔從其他平臺進行資料遷移,

在專案詳情頁點擊左側 API 功能,進入 API 管理頁面,直接點擊下拉框選擇匯入 API ,


配置匯入規則:
選項說明:
-
將 API 匯入到以下分組:選擇對應的 API 分組
-
將新生成的 API 檔案狀態設定為:可以將匯入 API 檔案設定對應狀態
-
將發生變更的 API 檔案狀態設定為:對已發生變更狀態的 API 檔案,可以更新指定的檔案狀態
-
將新生成的或發生變更的 API 檔案的版本號設定為:可以將匯入 API 檔案設定指定的 API 版本號

設定好匯入配置規則后,點擊確定會顯示成功提示, 并在右側欄顯示我的任務佇列進行中,當狀態顯示完成就匯入成功了,
如下圖:

重繪界面就可匯入 API 資料:

自動生成檔案
通過使用介面檔案工具 Eolink 演示如何自動生成檔案,
用戶可以實作給專案關聯的 Swaqger 生成的 JSON 檔案地址,Eolink 的 API 研發管理平臺就能夠遠程讀取 Swagger JSON 檔案地址并自動生成 API 檔案,
**進入 API 管理與測驗,選擇專案,左側欄的其他可以看到 API 檔案生成,**

添加來源,在彈窗中選擇通過 Swagger URL 生成 API 檔案 ,然后點擊下一步:

輸入 Swagger 生成的 JSON 地址,注意該 JSON 地址需要能夠通過網路訪問,并且該地址回傳的資料需要是 JSON 型別的資料,否則會提示無法訪問該地址,

配置完成后,界面會提示配置完成,此時您可以通過當前頁面點擊 同步 按鈕,或通過 Open API 觸發同步操作,

使用 API Factory 產品根據資料庫生成 API 檔案
API Factory( API 快速生成工廠)能夠幫助用戶直接從各種常見關系資料庫、 NoSQL 資料庫、大資料庫中間件中生成統一格式的 HTTP Restful API ,通過 API Factory,您可以通過撰寫 SQL 腳本或通過 UI 方式直接創建一個高性能的資料庫操作 API ,
以上三種方法是生成 API 檔案最常見的方法,通過使用一款好用的介面檔案工具實作 API 檔案匯入生成、自動生成 API 檔案,以及使用 API Factory 產品資料庫生成 API 檔案,讓開發在書寫檔案程序中不再痛苦,提高前后端的開發效率,
這里推薦上圖做演示的這款介面檔案工具,Eolink,它能設計、管理 API ,一鍵生成 API 檔案,除此之外還能直接打通介面測驗,一鍵發起 API 測驗,方便快捷且功能強大,如有興趣可自行試用:www.eolink.com
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/500784.html
標籤:其他
上一篇:解決word插入新圖片后原有圖片題注的交叉參考錯亂的問題
下一篇:Fastjson反序列化
