這篇文章詳細(xì)記錄了我如何實(shí)現(xiàn)一個(gè) OpenAPI 的艱辛歷程、我把 OpenAPI 從概念、設(shè)計(jì)、實(shí)現(xiàn)、部署、測試、監(jiān)控的整個(gè)過程詳細(xì)的提供給大家學(xué)習(xí)和參考。
提綱
- 如何打造一個(gè)自己的 OPEN API
- 如何設(shè)計(jì)一個(gè)符合 RESTful 的 OpenAPI
- 使用 .Net Core 實(shí)現(xiàn)自己的 OpenAPI
- 使用 Java Spring Boot 實(shí)現(xiàn)自己的 OpenAPI
- 如何提高 OpenAPI 健壯性
- 如何實(shí)現(xiàn) OpenAPI 的高可用
OpenAPI 是什么?
Open API 即開放 API，也稱開放平臺(tái)。 所謂的開放 API（OpenAPI）是服務(wù)型網(wǎng)站常見的一種應(yīng)用，網(wǎng)站的服務(wù)商將自己的網(wǎng)站服務(wù)封裝成一系列
API（Application Programming Interface，應(yīng)用編程接口）開放出去，供第三方開發(fā)者使用，這種行為就叫做開放網(wǎng)站的 API，所開放的 API 就被稱作 OpenAPI（開放 API ）。
RESTful API 是什么?
什么是 REST？
Representational State Transfer，翻譯是”表現(xiàn)層狀態(tài)轉(zhuǎn)化”。可以總結(jié)為一句話：REST 是所有 Web 應(yīng)用都應(yīng)該遵守的架構(gòu)設(shè)計(jì)指導(dǎo)原則。
面向資源是 REST 最明顯的特征，對于同一個(gè)資源的一組不同的操作。資源是服務(wù)器上一個(gè)可命名的抽象概念，資源是以名詞為核心來組織的，首先關(guān)注的是名詞。REST 要求，必須通過統(tǒng)一的接口來對資源執(zhí)行各種操作。對于每個(gè)資源只能執(zhí)行一組有限的操作。
什么是 RESTful API？
符合 REST 設(shè)計(jì)標(biāo)準(zhǔn)的 API，即 RESTful API。REST 架構(gòu)設(shè)計(jì)，遵循的各項(xiàng)標(biāo)準(zhǔn)和準(zhǔn)則，就是 HTTP 協(xié)議的表現(xiàn)，換句話說，HTTP 協(xié)議就是屬于 REST 架構(gòu)的設(shè)計(jì)模式。比如，無狀態(tài)，請求-響應(yīng)。。。
Swagger 是什么?
Swagger? 的目標(biāo)是為 REST APIs 定義一個(gè)標(biāo)準(zhǔn)的，與語言無關(guān)的接口，使人和計(jì)算機(jī)在看不到源碼或者看不到文檔或者不能通過網(wǎng)絡(luò)流量檢測的情況下能發(fā)現(xiàn)和理解各種服務(wù)的功能。當(dāng)服務(wù)通過 Swagger 定義，消費(fèi)者就能與遠(yuǎn)程的服務(wù)互動(dòng)通過少量的實(shí)現(xiàn)邏輯。類似于低級(jí)編程接口，Swagger 去掉了調(diào)用服務(wù)時(shí)的很多猜測。
OpenAPI 展示
