【API設(shè)計(jì)】 引言：應(yīng)該使用ORM框架嗎？ 毋庸置疑，Sticker微服務(wù)需要訪問數(shù)據(jù)庫來管理“貼紙”（也就是“Sticker”），因此，以什么方式來存儲數(shù)據(jù)，就是一個無法繞開的話題。如果你遵循領(lǐng)域驅(qū)動設(shè)計(jì)的思想，那么你可以說，保存到數(shù)據(jù)庫的數(shù)據(jù)，...

【API設(shè)計(jì)】 涉及知識點(diǎn) Gin：Golang 的一個微框架，性能極佳。 beego-validation：本節(jié)采用的 beego 的表單驗(yàn)證庫，中文文檔。 gorm，對開發(fā)人員友好的 ORM 框架，英文文檔 com，一個小而美...

【API設(shè)計(jì)】 思考 首先，在一個初始項(xiàng)目開始前，大家都要思考一下 程序的文本配置寫在代碼中，好嗎？ API 的錯誤碼硬編碼在程序中，合適嗎？ db 句柄誰都去Open，沒有統(tǒng)一管理，好嗎？ 獲取分頁等公共參數(shù)，誰都自己寫一...

【API設(shè)計(jì)】 一、 背景 gin框架作為一個普遍使用的http服務(wù)開源框架，為了能更好地使用它，我們有必要對gin框架有個清晰的認(rèn)識，了解框架中請求處理流程、中間件執(zhí)行等細(xì)節(jié)。gin框架基于golang基礎(chǔ)庫 net/http 進(jìn)行開發(fā)，先了解 n...

【API設(shè)計(jì)】 方案設(shè)計(jì) 開始開發(fā)之前我們先看一下 gin 的路由是怎么注冊的，以及 grpc 生成的接口格式是什么樣的 gin example package main?import "github.com/gin-gonic/gin"...

【API設(shè)計(jì)】 序 在 Go 工程化(二) 項(xiàng)目目錄結(jié)構(gòu) 中我們大概講了一下 api 目錄，但是并沒有詳細(xì)的說明，留在這這篇文章一起講。 API 設(shè)計(jì)將分為四個部分: 首先會講一下 API 的項(xiàng)目目錄結(jié)構(gòu)，在項(xiàng)目中 api 該如何組織，...

【API設(shè)計(jì)】 WebSocket 示例界面 第三方包 gorilla/websocket[1] websocket?鏈接時支持配置項(xiàng)： type Upgrader struct { // 指定升級 webso...

【API設(shè)計(jì)】 gin 是golang 中比較流行的框架，很多系統(tǒng)都是在該框架下開發(fā)的，這個框架給我的感覺像是Flask在python中的位置，基礎(chǔ)的功能都有，但是如果想要很好的使用，還需要開發(fā)很多自己的功能與中間件，在看過不少的教程以后，想要記錄一下學(xué)習(xí)...

【API設(shè)計(jì)】 數(shù)據(jù)安全一直是個熱門的話題，API 接口在數(shù)據(jù)的傳輸上扮演著至關(guān)重要的角色。為了 API 接口的安全性、健壯性，完整性，往往需要將網(wǎng)絡(luò)上的數(shù)據(jù)進(jìn)行簽名加密傳輸。同時為了防止 API 接口被重放爬蟲偽造等類似惡意攻擊的手段，還要在接口設(shè)計(jì)時增加有效時間、隨機(jī)字符串、簽名串等參數(shù)，來保障數(shù)據(jù)的安全性。這一次的 API 接口簽名設(shè)計(jì)實(shí)踐，大家也可以手動嘗試實(shí)驗(yàn)一下，希望對大家的日常工作能有所幫助。

【API設(shè)計(jì)】 API 優(yōu)先方法強(qiáng)調(diào)在軟件開發(fā)生命周期伊始就將 API 設(shè)計(jì)與創(chuàng)建置于核心地位，將其視為決定其他應(yīng)用程序代碼開發(fā)的基礎(chǔ)組件，從而確保服務(wù)之間的一致性與可重用性，為應(yīng)用程序帶來可擴(kuò)展性、靈活性以及與微服務(wù)架構(gòu)的無縫集成等顯著優(yōu)勢。有效的 API 優(yōu)先策略實(shí)施涵蓋全面的文檔、標(biāo)準(zhǔn)化的錯誤處理和強(qiáng)大的 API 治理，這不僅培養(yǎng)了更佳的開發(fā)人員體驗(yàn)、激發(fā)創(chuàng)新活力，還使得 API 能夠在組織內(nèi)跨不同語言和平臺實(shí)現(xiàn)無縫交互，支持無依賴項(xiàng)的升級與更新，極大地增強(qiáng)了系統(tǒng)的健壯性與靈活性。盡管在采用 API 優(yōu)先實(shí)踐過程中可能存在諸如文化轉(zhuǎn)變、技術(shù)多樣性管理等挑戰(zhàn)，但其帶來的顯著架構(gòu)優(yōu)勢不容小覷，能夠加快產(chǎn)品上市時間、實(shí)現(xiàn)經(jīng)濟(jì)高效的應(yīng)用程序開發(fā)，推動組織在激烈的市場競爭中保持領(lǐng)先，引領(lǐng)軟件開發(fā)邁向更具前瞻性與戰(zhàn)略性的新階段。

【API設(shè)計(jì)】 API網(wǎng)關(guān)是隨著微服務(wù)概念興起的一種架構(gòu)模式。原本一個龐大的單體應(yīng)用（All in one）業(yè)務(wù)系統(tǒng)被拆分成許多微服務(wù)系統(tǒng)進(jìn)行獨(dú)立的維護(hù)和部署，服務(wù)拆分帶來的變化是API的規(guī)模成倍增長，API的管理難度也在日益增加，使用API網(wǎng)關(guān)發(fā)布和管理API逐漸成為一種趨勢。一般來說，API網(wǎng)關(guān)是運(yùn)行于外部請求與內(nèi)部服務(wù)之間的一個流量入口，實(shí)現(xiàn)對外部請求的協(xié)議轉(zhuǎn)換、鑒權(quán)、流控、參數(shù)校驗(yàn)、監(jiān)控等通用功能。

【API產(chǎn)品】 2022 年是科技圈艱難的一年，很少有振奮人心的消息。驚喜的是年底 OpenAI 開放的 ChatGPT，一下點(diǎn)燃了整個科技圈，體驗(yàn)后感覺有點(diǎn)像人腦，智能化程度驚艷。曾經(jīng)我和朋友常調(diào)侃人工智能就是“有多少人工，就有多少智能”，ChatGPT...

【API設(shè)計(jì)】 本文探討了微軟開源的Autogen框架，該框架基于大型語言模型（LLM）構(gòu)建自治代理（autonomous agents），支持多個代理的協(xié)作以實(shí)現(xiàn)共同目標(biāo)。Autogen允許代理進(jìn)行單聊和群聊，并提供多種發(fā)言人選擇方法。盡管該框架在實(shí)現(xiàn)多個代理的協(xié)作方面具有優(yōu)勢，但在將其集成到實(shí)際生產(chǎn)環(huán)境中（如Web APP）時仍面臨一些挑戰(zhàn)，如缺乏成熟的文檔和資源。 文章詳細(xì)介紹了如何使用Autogen構(gòu)建一個基于API的旅游代理系統(tǒng)，包含多個角色的代理，例如旅游代理、位置研究員和用戶代理。系統(tǒng)通過與SERP API的交互，允許代理收集和處理用戶的旅行需求。最后，文章討論了在群聊中提高代理協(xié)作可預(yù)測性和一致性的可能方法，包括修改發(fā)言人選擇邏輯和使用圖模型來強(qiáng)制執(zhí)行發(fā)言者轉(zhuǎn)移路徑。 總體而言，文章展示了Autogen在多代理系統(tǒng)中的應(yīng)用潛力及其在實(shí)際應(yīng)用中面臨的挑戰(zhàn)與解決方案。

【API設(shè)計(jì)】 文章總結(jié)了API設(shè)計(jì)中應(yīng)遵循的重要原則。首先強(qiáng)調(diào)了簽名的重要性，通過將請求參數(shù)、時間戳和密鑰拼接后進(jìn)行hash算法處理生成簽名，以防止數(shù)據(jù)被篡改，并通過時間戳限制請求的有效期。在數(shù)據(jù)安全方面，建議對敏感數(shù)據(jù)進(jìn)行加密，如使用AES對稱加密算法保護(hù)用戶密碼等重要信息。此外，文章還提出了其他設(shè)計(jì)要點(diǎn)，包括設(shè)置IP白名單以限制訪問來源、實(shí)施限流策略以避免服務(wù)過載、進(jìn)行嚴(yán)格的參數(shù)校驗(yàn)以攔截?zé)o效請求、統(tǒng)一返回值和異常處理以簡化維護(hù)工作、記錄詳細(xì)的請求日志以便快速定位問題、設(shè)計(jì)冪等接口以避免重復(fù)操作、限制批量接口的記錄條數(shù)以防止超時、進(jìn)行壓力測試以評估接口性能、采用異步處理以提升性能、對敏感數(shù)據(jù)進(jìn)行脫敏處理以保護(hù)隱私、提供完整的接口文檔以降低對接成本、合理選擇請求方式、利用請求頭傳遞公共參數(shù)、設(shè)計(jì)批量接口以提高通用性以及遵循職責(zé)單一原則以降低維護(hù)難度。這些軍規(guī)旨在幫助開發(fā)者設(shè)計(jì)出更安全、高效、易維護(hù)的API接口。

【API設(shè)計(jì)】 本文深入探討了提升系統(tǒng)性能和優(yōu)化技術(shù)的關(guān)鍵策略，包括并行處理、最小化事務(wù)范圍、緩存應(yīng)用、合理使用線程池、服務(wù)預(yù)熱、緩存對齊、減少對象產(chǎn)生、并發(fā)處理、異步處理以及循環(huán)優(yōu)化等十二個方面。文章強(qiáng)調(diào)了在高并發(fā)場景下，通過減少事務(wù)范圍和合理使用緩存來提升系統(tǒng)響應(yīng)速度和可靠性。同時，討論了線程池的配置和監(jiān)控、服務(wù)預(yù)熱、緩存對齊以及減少對象產(chǎn)生的重要性，這些措施有助于降低系統(tǒng)延遲和提高吞吐量。