你是否曾經空有請求位址，卻對如何調用接口感到無從下手？
對接外部系統時，你是否也曾為不滿足對方格式要求而苦惱？
接口開發完，你是否還在頻繁切換調試工具？
API文檔不全，最終隻能人工編寫項目接口文檔？
别擔心！這些問題，金蝶雲·蒼穹新版OpenAPI引擎幫你全搞定！
适用版本：該功能适用版本為金蝶雲·蒼穹V5.0.002及以上。
功能簡介
新版OpenAPI引擎相較舊版本的API引擎，入參扁平化，更易于第三方系統解析。支援JSON、XML、SOAP1.0、SOAP1.2、form-data、x-www-form-urlencoded等格式的請求參數。開發者能通過以下三種方式進行API開發：
1）零代碼配置：按接口調用場景，在API維護界面配置基本資訊和請求參數，一鍵生成OpenAPI。
2）Java插件開發：使用Java代碼插件，解決複雜的業務場景，如調用微服務或對檔案流、圖像等進行處理。
3）腳本開發：使用腳本，可實作多個API、微服務、函數庫等之間的組合調用，開發便捷，部署靈活。
功能詳情
01 打開API管理清單
路徑：【開發服務雲】→【開放平台】→【API管理】，此處統一管理所有新版本（V2）的API接口，點選“新增”按鈕，在彈窗中可選擇建立“操作API”或“自定義API”。
編輯
API管理界面
02 零代碼配置API
如何零代碼維護API呢？以最常見的查詢操作接口為例，分為以下步驟：
1）錄入API基本資訊：API編碼、API名稱、業務對象、操作方式、較長的描述，API請求位址自動生成。
2）定義請求頭部：無需維護，系統預置了content_type(内容類型）和accesstoken（請求令牌）兩個參數。
3）定義query參數：即定義請求的入參，這些參數會作為查詢條件的比較變量，界面設定參數類型和是否必填。
4）定義查詢條件：即定義查詢類請求的過濾條件，将業務對象中的字段和傳入參數（比較變量）進行比較，來過濾篩選指定的資料，同時支援常量查詢。
定義查詢條件示例
5）定義排序（可選）：使用者可在界面定義傳回參數展示的排序方式。
6）定義傳回參數：即定義請求的出參，确認後點選“儲存”按鈕，則完成API維護。
7）定義錯誤碼：定義請求錯誤碼和描述。
編輯
定義傳回參數和錯誤碼示例
8）維護完畢後即可進行線上測試，點選按鈕“API測試”，可實時調試API接口。
編輯
API測試示例
03 Java代碼插件開發API
Java代碼插件開發自定義API，主要解決複雜的業務場景，如調用微服務或對檔案流、圖像等進行處理。使用者預先定義好類和方法，在開放平台進行簡單的接口配置後，系統便會自動解析定義好的請求參數和傳回參數，快速友善地生成自定義接口。
編輯
自定義API配置示例
相關代碼示例如下：
@ApiModel
public class CustomDemo2Model implements java.io.Serializable {
private static final long serialVersionUID = 703398913563944102L;
@ApiParam("ID")
private Long id;
@ApiParam(value = "編碼", required = true)
private String number;
@ApiParam(value = "名稱", required = true)
private String name;
@ApiParam("餘額")
private int balance;
@ApiParam("日期")
private Date date;
...
} 04 腳本開發API
腳本開發的模式釋出API，可實作多個API、微服務、函數庫等之間的組合調用，開發便捷，部署靈活，其通過腳本實作邏輯，無需開發Java代碼，更便捷。
編輯
腳本開發API示例
05 API文檔
路徑：【開發服務雲】→【開放平台】→【API文檔】，此處展示API接口基本資訊、請求參數、請求結構示例、傳回參數和傳回結構示例、錯誤碼等資訊；支援導出HTML、PDF檔案以及擷取匿名連結等功能，幫助開發人員快速上手，提升系統對接效率。
編輯
API文檔界面
亮點價值
亮點一：新版API引擎參數扁平化，支援多種入參格式，更易于對接外部系統。
亮點二：操作API無需代碼開發，通過界面配置快速生成場景化的接口，使用門檻低，改善開發體驗。
亮點三：自動生成API文檔，包含完整的請求參數和傳回參數示例，可直接用于接口調試，提升使用者體驗。