如何生成 REST API 文件

LS的不錯，招搖功能還是弱的，定位也不是很好。 推薦使用Eolinker，推薦視覺化介面，支援文件自動生成，支援模擬資料，自動化測試，生成SDK，團隊協作等。 EOLINKER也是中國最大的介面管理平台

如果你想生成 RESTful 文件，可以在 Eolinker 上填寫一些基本的 API 資訊。

REST是Representational State Transfer的縮寫，直譯為Representational State Transfer。

RESTful API 是乙個 REST 風格的網路介面，它描述了網路中客戶端和伺服器之間的一種互動形式。 REST本身並不實用，實用的是如何設計。

在服務端提供的 RESTful API 中，URL 中只使用名詞來指定資源，原則上不使用動詞。 “資源”是REST架構或整個網路過程的核心。

rest apl指滿足應用程式設計的一組體系結構約束和原則。 架構，軟體架構分為三個部分：構建，用於描述計算機; 聯結器，用於描述構建的鏈結部分; 這種配置使構建和聯結器成為乙個有凝聚力的整體。

軟體架構風格，一種設計風格，而不是標準，只是提供了一組設計原則和約束。 它主要用於客戶端-伺服器互動類軟體。 基於這種風格設計的軟體可以更簡潔、更層次分明，並且更容易實現快取等機制。

原則條件：REST是指一組架構約束和原則。 滿足這些約束和原則的應用程式或設計是 RESTful。

Web 應用程式最重要的 REST 原則是客戶端和伺服器之間的互動在請求之間是無狀態的。 從客戶端到伺服器的每個請求都必須包含理解請求所需的資訊。 如果伺服器在請求之間的任何時間點重新啟動，則不會通知客戶端。

此外，任何可用的伺服器都可以發出無狀態請求，這對於雲計算等環境來說是理想的選擇。 客戶端可以快取資料以提高效能。

定義規則：REST中的資源不是指資料，而是指資料和表示的組合，例如，“最近訪問的10個成員”和“10個最活躍的成員”在資料上可能重疊或相同，並且由於它們的表現形式不同，它們被歸類為不同的資源，這就是為什麼REST的全稱是具象狀態轉移。

資源識別符號是 URI（統一資源識別符號），無論是 **、Word、** 檔案，甚至只是乙個虛擬服務，也不管你是 XML（標準通用標記語言的子集）格式、TXT 檔案格式還是其他檔案格式，所有這些都通過 URI 唯一標識資源。

REST 的完整拼寫是 （representational state transfer）。 REST 是指一組架構約束和原則，這些約束和原則滿足 RESTful 應用程式設計的要求。

REST是指一組滿足應用程式設計的約束和原則的體系結構約束和原則。

REST API，無論它的名字多麼崇高，本質上都是乙個HTTP請求，無論是POST還是GET，它都是不同的資料提交方式。 因此，可以確定 REST API 的以下方面：uri、引數、請求方法、請求標頭等。

API平台的架構其實和底層公司的業務系統架構息息相關，基於乙個好的系統架構來編寫乙個REST API平台，基本上是理所當然的。

REST 是最流行的 API 設計理論之一。 由於結構清晰，符合標準，易於理解，易於擴充套件，因此被用於越來越多的應用場景。 REST（Representational State Transfer）於 2000 年首次出現在 Roy Thomas Fielding 博士的著作中，它指的是一組架構約束和原則。

滿足這些約束和原則的應用程式或設計是 RESTful。

2000年，Roy Thomas Fielding博士首次發表了REST（Representational State Transfer）一文，提出了一種全球資訊網軟體架構風格——REST，旨在促進不同軟體程式（例如Internet）之間的資訊傳輸。 它指的是一組體系結構約束和原則。

滿足這些約束和原則的應用程式或設計是 RESTful。

資源，REST是“表示狀態轉換”，實際上省略了主題。 “表示層”實際上是指“資源”的“表示層”。 那麼什麼是資源呢？

通常訪問 Internet**、文字、文件等都是資源，通常按 uri 定位。 換句話說，URI 表示資源。

在表示級別，資源用作特定的實體資訊，可以以多種方式呈現。 實體的表示就是表示層。 例如，txt 文字訊息，可以輸出為 html、json 等。

狀態傳輸，訪問**，表示客戶端和伺服器之間的互動。 在此過程中，資料和狀態會發生變化。 HTTP協議是無狀態的，所以狀態必須儲存在伺服器端，所以如果客戶端想通知伺服器資料和狀態的變化，就需要以某種方式通知它。

客戶端可以通知伺服器的唯一方式是 HTTP 協議。 具體來說，在 HTTP 協議中，有四個動詞表示操作模式：get、post、put 和 delete。

它們對應於四個基本操作：

獲取資源。

POST 用於建立新資源（也可用於更新資源）。

put 用於更新資源。

delete 用於刪除資源。

Web 鏈結。