檢測(cè)到您已登錄華為云國(guó)際站賬號(hào)，為了您更好的體驗(yàn)，建議您訪問(wèn)國(guó)際站服務(wù)網(wǎng)站 http://m.cqfng.cn/intl/zh-cn
不再顯示此消息
中國(guó)站
中國(guó)站
International
Europe
檢測(cè)到您已登錄華為云國(guó)際站賬號(hào)，為了您更好的體驗(yàn)，建議您訪問(wèn)國(guó)際站服務(wù)網(wǎng)站 http://m.cqfng.cn/intl/zh-cn
不再顯示此消息
?? API 設(shè)計(jì)規(guī)范：RESTful & GraphQL 微服務(wù)之間的通信通常是通過(guò)API進(jìn)行的，如何設(shè)計(jì)優(yōu)雅的API規(guī)范至關(guān)重要。常見(jiàn)的API設(shè)計(jì)規(guī)范有RESTful和GraphQL，我們來(lái)逐一看一下它們的特點(diǎn)和應(yīng)用場(chǎng)景。 1.
例如：缺少API設(shè)計(jì)規(guī)范時(shí)，一個(gè)服務(wù)可能有多個(gè)設(shè)計(jì)者，設(shè)計(jì)者通常根據(jù)以往的經(jīng)驗(yàn)或者模仿已有的API樣例做設(shè)計(jì)，這將導(dǎo)致同一個(gè)服務(wù)設(shè)計(jì)的API存在各種差異（鑒權(quán)、命名、參數(shù)、錯(cuò)誤碼等），逐漸累積并加劇后期API管理及維護(hù)的難度。
Q：CodeArts API平臺(tái)支持哪些API設(shè)計(jì)標(biāo)準(zhǔn)和規(guī)范？ A:目前只支持華為云API設(shè)計(jì)規(guī)范，詳情請(qǐng)登錄產(chǎn)品，在項(xiàng)目設(shè)置->設(shè)計(jì)規(guī)范設(shè)置中查看。 Q：API治理過(guò)程中，如何做好API的安全和隱私保護(hù)？
RESTful 是目前最流行的 API 設(shè)計(jì)規(guī)范，用于 Web 數(shù)據(jù)接口的設(shè)計(jì)。它的大原則容易把握，但是細(xì)節(jié)不容易做對(duì)。本文總結(jié) RESTful 的設(shè)計(jì)細(xì)節(jié)，介紹如何設(shè)計(jì)出易于理解和使用的 API。
微服務(wù)架構(gòu)原則 微服務(wù)設(shè)計(jì)規(guī)范 微服務(wù)API接口設(shè)計(jì)規(guī)范 微服務(wù)網(wǎng)關(guān)設(shè)計(jì) 父主題： 需求評(píng)估
企業(yè)可以采取以下措施來(lái)做好API全生命周期管理： 制定API管理策略：企業(yè)需要明確API管理策略，包括API設(shè)計(jì)規(guī)范、開(kāi)發(fā)標(biāo)準(zhǔn)、測(cè)試流程、部署規(guī)范等。
現(xiàn)在，RESTful是目前最流行的接口設(shè)計(jì)規(guī)范，在很多公司有著廣泛的應(yīng)用，其中Github 的API設(shè)計(jì)就是很標(biāo)準(zhǔn)的RESTful API，你可以參考學(xué)習(xí)。
總結(jié) 作為微服務(wù)之間的橋梁，API設(shè)計(jì)和維護(hù)是微服務(wù)架構(gòu)中很重要的一個(gè)環(huán)節(jié)，每個(gè)開(kāi)發(fā)人員不僅僅需要良好的代碼規(guī)范，也需要建立并遵守API設(shè)計(jì)規(guī)范。
現(xiàn)在，RESTful是目前最流行的接口設(shè)計(jì)規(guī)范，在很多公司有著廣泛的應(yīng)用，其中Github 的API設(shè)計(jì)就是很標(biāo)準(zhǔn)的RESTful API，你可以參考學(xué)習(xí)。
1.2 RESTful API設(shè)計(jì)規(guī)范 在設(shè)計(jì)RESTful API時(shí)，遵循一些基本的規(guī)范可以提高接口的易用性和一致性： HTTP方法的正確使用： GET：用于獲取資源。 POST：用于創(chuàng)建資源。 PUT：用于更新資源。 DELETE：用于刪除資源。
本文將基于React+Antd技術(shù)棧，通過(guò)HTML5原生API實(shí)現(xiàn)零依賴的拖拽功能，在Modal彈窗中構(gòu)建動(dòng)態(tài)文件歸類(lèi)系統(tǒng)。方案核心價(jià)值在于： 無(wú)第三方依賴：純?cè)鷮?shí)現(xiàn)，避免組件庫(kù)升級(jí)風(fēng)險(xiǎn)。 企業(yè)級(jí)封裝：完美兼容Antd API設(shè)計(jì)規(guī)范。
可監(jiān)控API監(jiān)控一方面在服務(wù)設(shè)計(jì)和實(shí)現(xiàn)中考慮日志監(jiān)控和診斷，需要建立異常通知機(jī)制及人工干預(yù)的異常處理控制臺(tái)，API調(diào)用發(fā)生異常時(shí)能快速定位解決問(wèn)題。 父主題： 微服務(wù)API接口設(shè)計(jì)規(guī)范
設(shè)置時(shí)間窗口的API接口詳情請(qǐng)參見(jiàn)設(shè)置集群均衡活動(dòng)時(shí)間窗。需要基于分片鍵排序查詢且增加數(shù)據(jù)時(shí)可以分布均勻建議使用范圍分片，其他使用哈希分片。 合理設(shè)計(jì)shard key，防止出現(xiàn)大量的數(shù)據(jù)使用相同shard key，導(dǎo)致出現(xiàn)jumbo chunk。
設(shè)置時(shí)間窗口的API接口詳情請(qǐng)參見(jiàn)設(shè)置集群均衡活動(dòng)時(shí)間窗。需要基于分片鍵排序查詢且增加數(shù)據(jù)時(shí)可以分布均勻建議使用范圍分片，其他使用哈希分片。合理設(shè)計(jì)shard key，防止出現(xiàn)大量的數(shù)據(jù)使用相同shard key，導(dǎo)致出現(xiàn)jumbo chunk。
對(duì)于靈活一些的第三方應(yīng)用來(lái)講，一般使用REST_API對(duì)接。Manager的REST_API接口提供了全量的運(yùn)維管理能力。為標(biāo)準(zhǔn)化Manager REST_API接口的設(shè)計(jì)開(kāi)發(fā)，制定了該規(guī)范。
二、RESTful API 設(shè)計(jì)規(guī)范 1. 面向資源設(shè)計(jì) URL 面向使用者建模 資源不是數(shù)據(jù)模型， 也不是領(lǐng)域模型，它的語(yǔ)義應(yīng)該面向使用者。
微服務(wù)設(shè)計(jì)規(guī)范 可選：微服務(wù)劃分：從業(yè)務(wù)領(lǐng)域視角劃分服務(wù)微服務(wù)是開(kāi)發(fā)軟件的最可擴(kuò)展的方式。但是，您需要一個(gè)好的設(shè)計(jì)，讓開(kāi)發(fā)人員團(tuán)隊(duì)能夠自主工作并進(jìn)行部署，而不必互相干擾，否則您將失去最大的可擴(kuò)展性優(yōu)勢(shì)。
設(shè)計(jì)規(guī)范旨在幫助第三方應(yīng)用設(shè)計(jì)者們設(shè)計(jì)出滿足大屏交互需求的應(yīng)用，給用戶以友好、一致的體驗(yàn)。由于IdeaHub Board的尺寸較大、用戶的操作范圍和可視區(qū)域有限，為用戶創(chuàng)造良好的大屏體驗(yàn)存在一定的挑戰(zhàn)。
??Key的設(shè)計(jì)規(guī)范 ??Java對(duì)象存儲(chǔ)方案 ??Redis安全建議 Redis不要被外網(wǎng)訪問(wèn)，禁止bind 0.0.0.0 應(yīng)當(dāng)設(shè)置為bind 192.168.132.128 更改redis的默認(rèn)端口不要6379，可以設(shè)置成其他的如 -port 6677 Redis
3.2 源碼揭秘 查看Ribbon源碼，MaxAutoRetriesNextServer參數(shù)默認(rèn)為1，也就是Get請(qǐng)求在某個(gè)服務(wù)端節(jié)點(diǎn)出現(xiàn)問(wèn)題（比如讀取超時(shí)）時(shí)，Ribbon會(huì)自動(dòng)重試一次： 解決方案 把發(fā)短信接口從Get改為Post API設(shè)計(jì)規(guī)范：有狀態(tài)的API接口不應(yīng)定義為
