鯨品堂（táng）｜靈犀平台（tái）—API的（de）全可視化開（kāi）發

2021-10-27 1061

作為一個程序猿（yuán），接手一個老項目時，經常遇到無文檔無注釋，此時不提有多崩潰；作為一個設計人（rén）員，隻能等（děng）功能驗收時才能知道邏輯是（shì）否符合設（shè）計，若錯誤會造成大量返工和（hé）資源浪費；作為業務人員，隻能等（děng）軟件交付後才能驗證業（yè）務需求是否正確實現，若錯誤又要大大延長（zhǎng）需求交付周期；作（zuò）為一個新（xīn）人，要學習很多技（jì）術棧和編程知識才能加入到項目開發中，加上技術迭代這麽快，開（kāi）發門檻就更高了。

那我們是繼續這樣負重前行，還是尋求改變？能否（fǒu）尋（xún）求一種大家都更簡單更高效的模式，讓大家（jiā）都可（kě）以成為開發者（zhě）。

API開發的痛點分析

浩（hào）鯨科技每年要交付幾百個項目，根據項目不同，會（huì）涉及到多個產品研（yán）發和集成，過程中我（wǒ）們經（jīng）常遇到API開發的一些問題（tí），主要如下：

API無具體規範：導致溝通、聯調、接入成本巨大；

API開發無法很好的銜接，開發是把設計文檔轉譯為代碼；

API文檔不全，導致後期開發維護（hù）工作量巨大；

API技（jì）術棧很難標準化，多模塊（kuài）集成時經常遇到技術棧版本衝突；

API開發門檻高，需要懂語言、微（wēi）服（fú）務、分布式技術（shù）；

API的質（zhì）量不受控，基本依（yī）賴於開發（fā）人員技術能（néng）力（lì）。

總體上，API開發體驗還（hái）是比較差，開發門檻較高、效率較低、質量偏低。這種模式（shì）下（xià），業務開發（fā）無法聚焦於業務邏輯（jí）開發，很大精力要關注（zhù）技術問題，導致（zhì）業務開發（fā）效率（lǜ）大打（dǎ）折扣。

隨研發精進，国产亚洲熟妇在线视频科（kē）技逐步沉澱了（le）自己的技術框（kuàng）架、業務框架和雲原生技術底座，解決了API開發部分（fèn）技術棧的（de）問題，無需從0開始研發；今年又發布了靈（líng）犀平台，解決（jué）了API研發主要痛點。

API全可視化開發（fā）

国产亚洲熟妇在线视频科（kē）技經過長期研發沉澱和抽（chōu）象，最終形成了靈（líng）犀快（kuài）速開發平台。靈犀快速開發平台（tái）是一個麵向“公民（mín）開發者”的開發平台，通過標準（zhǔn）化資產（chǎn）庫+技術開放體係+可視化（huà）開發工具快速構建軟件應用。“公民開發（fā）者”可（kě）以讓更多人參與到開發中，可以讓沒有編程經驗或者少量編程（chéng）經驗的人參與開發，可以讓業務谘（zī）詢師、產品經理、業務架構師、測試（shì）人員、項目經理、運維人員都可以成為開發人（rén）員。

上圖是靈犀平台（tái）的一個（gè）邏輯功能架構圖。靈犀快速開發平台底層基於雲原生技術框架，開發出的應用天然具（jù）備雲原生特性（xìng），平台（tái）提供了設計（jì）開發平台、運行引擎平台（tái）、基礎管理平台、資產（chǎn）管理平台。

靈（líng）犀平台提供了API的全程可（kě）視（shì）化研發，從API契約設計、API業務建模、API編程、API調測、API連接外部能力，助力API開發實現（xiàn）高效、低門檻（kǎn）、高質量的API開發，業（yè）務開發可（kě）以聚焦業務邏輯開發。

API契約可視化管理

由於API缺乏規範，導致溝通、聯調和接（jiē）入成本很高。尤其是涉及眾多子係統（tǒng）、子模塊進行集成聯調時候，經常由於個別模塊接口的變化導致集成（chéng）失敗，很多模塊重複返（fǎn）工，浪費了大量資源（yuán）。

靈犀平台提供API的契約管理，提供了API契約設計、API契約查詢、API在線撥測（cè）。通過API契約化，研發有了共同語言，免去溝通（tōng）、聯調和接入的（de）痛點。

API契約設計：靈犀平台提（tí）供API契約設計，設計人員可以通過可視化（huà）設計工具定義API契約，可以定義好API訪問路徑、出入參數（shù）、調用樣例（lì）等。後續開發時候遵循契約進行開（kāi）發。

圖片關鍵詞

API契約查詢：靈犀平台提供（gòng）了API市場，所（suǒ）有發布的API都在市場（chǎng）中，在API市場中可以查詢到所有開放的API契約，聯調、接入時候可以按API市場定義契約。

API在（zài）線撥測：靈犀（xī）平（píng）台API市場還提供了API撥測功能，提供樣例直接調用API，可以清晰看到出入參結果，清晰知道入參填（tián）寫是否正確，免（miǎn）去溝通、聯調，讓接入者、使用（yòng）者有更直（zhí）接的體驗。

圖片關鍵詞

API可（kě）視化（huà）業務建模

靈犀平台提供了API的可視化業務建模，可以創建業務模型（xíng），而後在業務模（mó）型基礎（chǔ）上創建業務對（duì）象。

業務（wù）建模：靈犀平台提供靈活多樣的業務建模能力，可以根據實際場（chǎng）景選擇不同的建模（mó）方（fāng）式（shì）。若是新項目，可以直接在靈犀平台上手工建模，或者（zhě）通過SQL自動創建模型；若（ruò）是老項目，可以（yǐ）把模型批量導入。

行業模型庫：国产亚洲熟妇在线视频還沉澱了係列行業模（mó）型，業務建模時可以（yǐ）直接複用已有的行（háng）業模型（xíng），減少建模工作量。

圖片關鍵詞

業務對象設計：業務建模主要是（shì）完成數據的物理存儲，業務對象提（tí）供模型如何跟（gēn）頁麵（miàn）、服務的對（duì）接。業務對象設計時候可以定義相關對象關係、對象屬性顯示規則、對（duì）象脫敏（mǐn）設置、對象屬性值設置等能力。

API可視化編程

傳統開發方式，對於需求分析和設計後（hòu），再由開發編碼轉換為實現。在編碼階段，由於編程知識和技（jì）術門（mén）檻，多數需求和設計都很難接入；對於API開發人員來說，要（yào）熟悉業務邏（luó）輯，還要熟悉各種技術棧，門檻比較高（gāo），而且代碼質量完全隨開發人員技能和心情（qíng）。

靈犀平台（tái）對常用的程（chéng）序控製邏輯（jí）、數據訪問、API集成、規（guī）則集（jí）成、業務流程集成、代碼（mǎ）段或函數（shù）複用進行了抽象和封裝，形成了幾（jǐ）十個常用組件，實現了API的（de）可視編程（chéng）。

靈犀平台提供API可視（shì）化編程、API處理邏輯，按流程（chéng）可視化展示（shì）、API處理邏輯瀏（liú）覽（lǎn）和查看、豐富的API組件供（gòng）對接數據庫、鏈接外部能（néng）力、自定義代碼。

API處理邏輯可視化：編（biān）排出的（de）API處（chù）理邏輯是一個可（kě）視化的流程圖，整個API的（de）處（chù）理邏輯（jí）一目了然。從需求人員和設計（jì）人員維度，通過流（liú）程圖很容易知道需（xū）求在開發落地（dì）中業務處理邏輯是否有問題（tí）。從客戶角（jiǎo）度，通過流程圖可以掌握業務的實際處理邏輯，清（qīng）晰了解到業務邏輯是否正確，實（shí）現知識的自（zì）主掌控。對於（yú）後（hòu）續接手人員來說，代（dài）碼即文檔，能夠快速上手，免去鑽研代碼的痛苦。

API拖拽式開發：點擊API處理流程，可以在流程上增加處理環節，提供20+的組件供選擇。包括我們（men）編程中使用的程序控製邏輯、數據操作、訪問（wèn）外部（bù）服務、集成規則、集成業務流程、集（jí）成函（hán）數或自定義（yì）代碼（mǎ）段、通知（zhī）等（děng）組件。可以滿足我們絕大部分API的開發訴求。

API處理邏輯（jí）查看：API業務處理邏輯開發完後，提供查詢回看功能。可以再查詢整體處理邏輯是否正確，每個環節的（de）出入參映射是否正確。

豐富的組件：

邏輯組件：提供了我們編程常（cháng）用（yòng）的（de）程序控製結構，有條件結構（gòu）、循環結構；條件結（jié）構提供單條件（if ）組件（jiàn）、分支判斷組件（if … else ）兩種；循環（huán）結構提（tí）供循環（huán）組件（jiàn）（loop ）和循環跳出組件（break）；還提（tí）供了過程變量的定定義。

數據組件：數（shù）據組件提供了對數據庫操作的封（fēng）裝（zhuāng），可以對查詢（xún）、更新、自定義查詢等關鍵邏輯進行封裝。提供了API編程中要對數（shù）據庫可視化能力。通過數數據訪問組件，可以根據業務（wù）要求快捷對數據進行操作。
服務組件：編程（chéng）過程免不（bú）了要調用外部係統或其他模塊的服務（wù），外部（bù）服務組件提供了外部服務訪問的封裝，拖拽外部服務組件就可以一鍵訪問外部服（fú）務，無無需任何代碼。
規則組件：規則組件（jiàn）實（shí）現跟規則中心對接，針對一些複雜業務（wù）邏輯需要通過業業務規則來控製時，可以使用規則組件來（lái）調用規則（zé）中（zhōng）心的能力，複用（yòng）規則的擴擴展能力實現業務邏輯的規則化。
流程組件：流程組（zǔ）件實現了調用流程平台已（yǐ）有流程的能力，若在API邏輯中要引用流程，可以使用流程組件調用流程平台的流（liú）程啟動、流程流（liú）轉（zhuǎn）等能力（lì）實現現對（duì）業務（wù）流（liú）程的控製（zhì），滿足業務（wù）處（chù）理中跟業務流程的關聯互動。
工具箱組件：若API處理邏輯中（zhōng）還需要需要做（zuò）一些特殊處（chù）理，需要單獨寫代碼實現，工（gōng）具箱組件提供一些（xiē）自定義函數庫供複（fù）用，可以直接使用工具箱的（de）函數數（shù）庫進行開發，也可以開發自己編寫擴展的函數直接集成到API處理環節中（zhōng）。

API在線調測

可視化開發可以有效降低API開發門檻，API開發完後，如何驗證API處理邏輯是否正確？靈犀平台（tái）提供在線調測（cè）功能，提供可視化調測，輕鬆搞定API處理邏輯的正確性。

API在（zài）線調測：API開發完後，點擊服務調測功能，調測功能提供API各環節處理鏈，提供每個（gè）環節的（de）出入參、處理（lǐ）耗（hào）時、處理詳細日誌信息。通過調測結果（guǒ），可（kě）以清晰明了看到每個環節的出入參值，可以知道對於環節參數映射是否存在問題。

圖片關鍵詞

圖片關鍵（jiàn）詞函數（shù）調測：API開發過（guò）程的工具箱組件可以提（tí）供自定義函數管理，對於自定義（yì）的函（hán）數也（yě）提供在線測試功（gōng）能。可以輸入函（hán）數入參對函數進行測試，驗證函數返回是否符合開發（fā）人（rén）員預期。

API能力連接器

API開發（fā）中，我們可能要與很（hěn）多外部（bù）平台、外部模塊對接，而由於各種曆史原因（yīn），各個平台的API的技術棧還會（huì）存在差異，對於比較（jiào）老些的係統，比如WebService，對於較新（xīn）的係統，基（jī）本采用微（wēi）服務架構，常用（yòng）的微服務技術棧（zhàn）有Dubbo、SpringCloud、gRPC等（děng），若（ruò）每個API編程都需要去對接不同的技術棧（zhàn），工作量會很大，對開發人員要求也會很（hěn）高。

靈犀平（píng）台提供API能力連接器，可以接入豐富的服務類型（xíng），麵（miàn）向（xiàng）開發者可以統一轉換為HTTP/HTTPS服務，免去開（kāi）發（fā）集成複雜多樣的（de）痛苦。

目前靈犀平台API能力連接器可以接入SOAP、Dubbo、NACOS、HTTP、gRPC、數據庫等不同類型的（de）API能力。

總結和展（zhǎn）望

我們回（huí）顧下，通過犀平台進行API開發跟通過其他模式開發比對：

	從（cóng）0開始開發	使用框架開發	使用靈（líng）犀（xī）平台開發
API設計	無	第三（sān）方工具	全可視化（huà）（契約、業務建模、業務邏輯）
API編程	直接編碼	直接編碼	可視化編程
API技術（shù）難（nán）度	高（要關注引入的所（suǒ）有技術）	中（框架解決了部分技術棧）	低（dī）（20+組件，開發聚焦業務（wù））
API調測（cè）難度	複（fù）雜	中等	簡單（在線（xiàn）調測（cè））
API集成	難	難（協調、溝通）	簡單（dān）（API市場上訂閱使用）
開發者門檻	高（全編碼）	中偏高（絕大部分編碼）	低（極少編碼）
開發效率	低	中（zhōng）	高
代碼質量	偏低（完全依賴開發）	中等偏低（大部分依（yī）賴開（kāi）發）	高（代碼絕大（dà）部分自動生成）

我們總結（jié）下（xià），通過靈犀平台開發API的好處（chù）：

高效率：業務開（kāi）發聚焦業務邏輯，無需關注（zhù）技術；

低成本：通過複用組件和能（néng）力，交付周期更短成本更低（dī）；通過API處理邏輯可視化展示，降低了後續開發維護成本；

低門檻：無需編程經驗（yàn），可以全民開發（fā）；

高（gāo）質量：代碼基本是自動生成（chéng），質量內建；

全程可視化：設計、編碼、調測都提供可視化（huà）工具；

自主掌控：API處（chù）理（lǐ）邏輯（jí）以流程圖可視化展（zhǎn）示，對客戶可以實現自主掌控。

靈犀平台今（jīn）年才發布，在整個平台（tái）上，在API開發上還有很長的路要走，在API開發能力上還需繼續演進：

API開發的架構：API開發發布後，采用Serverless架構承（chéng）載；API開發隻關注業務，不用關注資源、運行和（hé）運維；

API的能力連接器豐富：需要進一步豐富API的能力連接器，提供更多標準化能力，實現更豐富的API業務場景開發；包括消息服務、緩存服務、雲能力服務等；

API組件豐（fēng）富：提供更豐富的API組（zǔ）件（jiàn），滿足更豐富的API業（yè）務場景；包括文件處（chù）理類、協議轉換等（děng）。

媒體中心

媒體中心

鯨品堂（táng）｜靈犀平台（tái）—API的（de）全可視化開（kāi）發

鯨智百應

關於我（wǒ）們（men）

產品與解決方案

成功故事