![]() |
stoplight協(xié)作平臺(tái)
專(zhuān)用API
【更新時(shí)間: 2024.06.25】
Stoplight 是一個(gè)協(xié)作平臺(tái),為您的團(tuán)隊(duì)提供貫穿 API 生命周期的工具,幫助他們構(gòu)建 高效優(yōu)質(zhì) API。
每月39 美元
去服務(wù)商官網(wǎng)采購(gòu)>
|
瀏覽次數(shù)
93
采購(gòu)人數(shù)
0
試用次數(shù)
0
試用
收藏
×
完成
取消
×
書(shū)簽名稱(chēng)
確定
|
- API詳情
- 定價(jià)
- 使用指南
- 常見(jiàn) FAQ
- 關(guān)于我們
- 相關(guān)推薦


什么是stoplight協(xié)作平臺(tái)?
Stoplight 以現(xiàn)代 API 工作流程為設(shè)計(jì)理念,提供直觀的界面和周到的功能,為您的整個(gè) API 設(shè)計(jì)生命周期提供支持。Stoplight 平臺(tái)讓技術(shù)和非技術(shù)利益相關(guān)者能夠使用直觀的界面在 OpenAPI 和 JSON Schema 中創(chuàng)建和協(xié)作 API 設(shè)計(jì)。免費(fèi)開(kāi)始使用或選擇適合您和您的組織的計(jì)劃 - 從個(gè)人到專(zhuān)業(yè)團(tuán)隊(duì)選項(xiàng)。無(wú)論您使用一個(gè)還是 1,000 個(gè) API,與內(nèi)部、外部或混合協(xié)作者合作,我們都讓共享 API、跟蹤更改、管理依賴(lài)項(xiàng)和使用樣式指南變得輕而易舉。
什么是stoplight協(xié)作平臺(tái)接口?
stoplight協(xié)作平臺(tái)有哪些核心功能?
創(chuàng)建成功的 API 程序對(duì)您的 API 程序采取主動(dòng)的方法,以有效地創(chuàng)造一致的生產(chǎn)力并避免延誤和超支的負(fù)面影響。 |
降低風(fēng)險(xiǎn)并提高投資回報(bào)率聯(lián)網(wǎng)軟件對(duì)于當(dāng)今的消費(fèi)者而言必不可少。避免造成巨大風(fēng)險(xiǎn)和投資回報(bào)率降低的混亂開(kāi)發(fā)工作。 |
設(shè)計(jì)你的 API通過(guò)查看整個(gè) API 目錄、OAS 標(biāo)準(zhǔn)以及重用模型和組件的能力,每次都可以輕松創(chuàng)建高質(zhì)量的 API。 |
stoplight協(xié)作平臺(tái)的核心優(yōu)勢(shì)是什么?
輕松設(shè)計(jì)和記錄 API
使用可視化編輯器創(chuàng)建、原型化和共享 OpenAPI 描述和 JSON 模式。使用可編輯的 markdown 自動(dòng)生成世界一流的文檔。 |
鼓勵(lì)一致性和重用
利用一流的指導(dǎo)方針和組件庫(kù)優(yōu)化小型和大型 API 團(tuán)隊(duì)的開(kāi)發(fā)。輕松訪問(wèn)樣式指南和可重復(fù)使用的組件。 |
增強(qiáng)協(xié)作
在 Git 上的中央事實(shí)源中協(xié)作完成 API 設(shè)計(jì)和文檔。在 Stoplight 編輯器中跟蹤設(shè)計(jì)評(píng)論。將評(píng)論集成到您當(dāng)前的工作流程中。 |
具有令人愉悅的開(kāi)發(fā)人員體驗(yàn)的 API 文檔
從您最喜歡的 VCS 創(chuàng)建最新 API 設(shè)計(jì)資產(chǎn)集合,例如 OpenAPI 描述、JSON 架構(gòu)和文檔。搜索、重用和管理 API。 |
維護(hù)中心事實(shí)來(lái)源
使用中央存儲(chǔ)庫(kù)構(gòu)建內(nèi)部和外部 API,用于存儲(chǔ)所有 API 設(shè)計(jì)資產(chǎn)。輕松發(fā)現(xiàn)系統(tǒng)中現(xiàn)有的 OpenAPI 規(guī)范,并在 Stoplight 平臺(tái)內(nèi)進(jìn)行管理。 |
由 OpenAPI 支持的模擬服務(wù)器可加快開(kāi)發(fā)速度
讓您的前端和后端團(tuán)隊(duì)使用托管的模擬服務(wù)器進(jìn)行開(kāi)發(fā)。Stoplight 通過(guò)根據(jù) API 描述創(chuàng)建模擬服務(wù)器來(lái)補(bǔ)充您的工作流程。 |
在哪些場(chǎng)景會(huì)用到stoplight協(xié)作平臺(tái)?
-
API設(shè)計(jì)協(xié)作:當(dāng)團(tuán)隊(duì)需要共同設(shè)計(jì)、審查、修改和記錄API時(shí),Stoplight平臺(tái)提供了直觀的工具和界面,使得技術(shù)和非技術(shù)利益相關(guān)者都能夠參與API的設(shè)計(jì)過(guò)程。
-
模擬服務(wù)器加速開(kāi)發(fā):對(duì)于需要模擬API響應(yīng)以支持前端和后端開(kāi)發(fā)的團(tuán)隊(duì),Stoplight的模擬服務(wù)器功能可以根據(jù)API描述快速創(chuàng)建模擬環(huán)境,從而加速開(kāi)發(fā)過(guò)程。
-
企業(yè)規(guī)模API管理:對(duì)于大型企業(yè)或開(kāi)發(fā)團(tuán)隊(duì),Stoplight Enterprise提供了企業(yè)級(jí)API管理能力,如跨團(tuán)隊(duì)擴(kuò)展API設(shè)計(jì)工作、生成交互式文檔、在中央存儲(chǔ)庫(kù)中管理API設(shè)計(jì)資產(chǎn)、執(zhí)行標(biāo)準(zhǔn)以降低風(fēng)險(xiǎn)等。
-
API測(cè)試與驗(yàn)證:Stoplight平臺(tái)可以與其他測(cè)試工具集成,幫助團(tuán)隊(duì)在API設(shè)計(jì)和開(kāi)發(fā)過(guò)程中進(jìn)行驗(yàn)證和測(cè)試,確保API的正確性和性能。
-
API發(fā)布與監(jiān)控:一旦API設(shè)計(jì)完成并通過(guò)測(cè)試,Stoplight平臺(tái)還可以支持API的發(fā)布和監(jiān)控過(guò)程,確保API在生產(chǎn)環(huán)境中穩(wěn)定運(yùn)行,并收集和分析使用數(shù)據(jù)以進(jìn)行持續(xù)優(yōu)化。




步驟 1:在 Stoplight 中設(shè)置項(xiàng)目
- 前往https://stoplight.io/welcome
- 按照屏幕上的說(shuō)明進(jìn)行注冊(cè)、創(chuàng)建工作區(qū),然后登錄工作區(qū)。
- 點(diǎn)擊頂部的+ (添加項(xiàng)目)按鈕添加新項(xiàng)目。為項(xiàng)目命名,然后單擊創(chuàng)建 API 項(xiàng)目。
步驟 2:輸入 API 概覽信息
在本部分中,您將填充 API 概述部分中的字段,其中包括版本、名稱(chēng)、說(shuō)明、安全性、聯(lián)系人、許可證和其他一般詳細(xì)信息。對(duì)于本教程,我們準(zhǔn)備了示例信息,以便您輕松插入 Stoplight 編輯器。(注意:在藍(lán)色可擴(kuò)展部分中的示例信息中,對(duì)于沒(méi)有名稱(chēng)的字段,標(biāo)題位于 [括號(hào)] 中。)
要填充 API 概述:
- 在 Stoplight 側(cè)欄中,單擊API 概述。
- 使用下面灰色部分提供的信息在每個(gè)表單字段中輸入信息
步驟 3:輸入路徑和參數(shù)信息
現(xiàn)在輸入路徑和參數(shù)信息:
- 在側(cè)欄中,右鍵單擊“路徑”文件夾并選擇“新建路徑”。
- 輸入天氣并按回車(chē)鍵。
默認(rèn)情況下,Stoplight 會(huì)為天氣端點(diǎn)創(chuàng)建一個(gè) GET 操作。在我們的例子中,這很有效,因?yàn)榇硕它c(diǎn)有一個(gè) GET 端點(diǎn)。但如果沒(méi)有,您可以單擊其他可用操作來(lái)創(chuàng)建這些操作的詳細(xì)信息。
您可以刪除默認(rèn)/用戶/{用戶ID}和/用戶和端點(diǎn)。右鍵單擊每個(gè)端點(diǎn)并選擇刪除路徑。
- 在主窗口(不是側(cè)邊欄)中,將路徑的標(biāo)題從“您的 GET 端點(diǎn)”更改為“天氣”。
- 點(diǎn)擊左上角的標(biāo)簽按鈕,添加一個(gè)名為“天氣端點(diǎn)”的標(biāo)簽。
步驟 4:了解如何重用參數(shù)
OpenAPI 規(guī)范允許您通過(guò)將信息存儲(chǔ)在成分屬性。在 Stoplight 編輯器中,您可以通過(guò)在側(cè)欄的“參數(shù)”部分輸入?yún)?shù)信息來(lái)重復(fù)使用參數(shù)。(在后臺(tái)代碼中,這些信息存儲(chǔ)在成分。
為了了解其工作原理,讓我們重新使用其中一個(gè)查詢參數(shù)。
要重新使用參數(shù):
- 右鍵單擊側(cè)邊欄左下角的“參數(shù)”文件夾,然后選擇“新建查詢參數(shù)”。 (將顯示類(lèi)似于查詢參數(shù)部分的參數(shù)部分。)
- 輸入lon并按回車(chē)鍵。
- 填充隆此處的參數(shù)使用與之前相同的信息。
- 返回到天氣 GET 端點(diǎn)中輸入的上一個(gè)查詢參數(shù)部分隆參數(shù),然后單擊該參數(shù)的參考按鈕 參考按鈕。
- 搜索“lon”并選擇它。
- 當(dāng)您將參數(shù)鏈接到引用時(shí),圖標(biāo)將變?yōu)榧t色。
- 切換到代碼編輯器并搜索隆。您現(xiàn)在將看到對(duì)組件的引用
步驟 5:輸入響應(yīng)和響應(yīng)架構(gòu)信息
作為此端點(diǎn)的最后一步,您需要輸入響應(yīng)信息。響應(yīng)不僅包括示例響應(yīng),還包括描述響應(yīng)的架構(gòu)。架構(gòu)描述了響應(yīng)中的所有可能值、它們的數(shù)據(jù)類(lèi)型以及這些值是否是必需的。
要在 Stoplight 中輸入響應(yīng)信息:
- 在端點(diǎn)的參數(shù)部分下方,單擊+ Response按鈕??。然后單擊此展開(kāi)的 Response 部分中出現(xiàn)的+ Add Body按鈕。
- 在 Schema 選項(xiàng)卡上,單擊從 JSON 生成。
在這里,您將體驗(yàn)到 Stoplight 編輯器中最酷的功能之一。編輯器將自動(dòng)根據(jù)示例 JSON 響應(yīng)構(gòu)建響應(yīng)架構(gòu)。
- 復(fù)制下面的示例回復(fù)。
- 將您復(fù)制的 JSON 粘貼到灰色區(qū)域中,其中顯示“在下面粘貼或?qū)懸粋€(gè) JSON 示例...”(首先刪除空的花括號(hào),然后粘貼您的示例。)
- 單擊“生成”。Stoplight 會(huì)為您構(gòu)建架構(gòu)!
- 添加有關(guān)響應(yīng)元素的更多詳細(xì)信息:?jiǎn)螕裘總€(gè)屬性旁邊的“描述”并添加描述。單擊“其他屬性”并在示例字段中添加示例。
步驟 6:預(yù)覽、測(cè)試和發(fā)布輸出
您已完成創(chuàng)建 OpenAPI 規(guī)范,因此讓我們預(yù)覽、測(cè)試和發(fā)布測(cè)試文檔:
- 單擊右上角的預(yù)覽按鈕。
- 在側(cè)欄中,選擇/weather端點(diǎn)。
- 點(diǎn)擊屏幕頂部附近的“試用”選項(xiàng)卡。(請(qǐng)參閱下面的說(shuō)明 - 由于 API 的 CORS 限制,此功能現(xiàn)在無(wú)法使用。)
- 輸入您的 API 密鑰應(yīng)用程序ID參數(shù)。有關(guān)獲取 OpenWeatherMap API 密鑰的詳細(xì)信息,請(qǐng)參閱獲取 OpenWeatherMap API 密鑰。(您也可以輸入下圖所示的 API 密鑰。它不是文本,因?yàn)槿魏我晕谋拘问酱蛴〉?API 密鑰都會(huì)被供應(yīng)商利用,然后被禁用。)
- 輸入你的郵政編碼壓縮參數(shù)(例如 98058)。您可能需要滾動(dòng)才能找到 zip 參數(shù),因?yàn)樗鼈儼醋帜疙樞蚺判颉F聊粦?yīng)如下所示
指南詳情地址:https://stoplight.io/getting-started-with-stoplight




設(shè)計(jì)優(yōu)先。開(kāi)發(fā)更好。Stoplight是一個(gè)協(xié)作 API 設(shè)計(jì)平臺(tái),可讓您構(gòu)建出色的 API 并創(chuàng)建可擴(kuò)展的 API 程序,以推動(dòng)創(chuàng)新。
加入我們的團(tuán)隊(duì)
我們對(duì) API 和員工充滿熱情。查看我們母公司SmartBear.com上的職位空缺。




步驟 1:在 Stoplight 中設(shè)置項(xiàng)目
- 前往https://stoplight.io/welcome
- 按照屏幕上的說(shuō)明進(jìn)行注冊(cè)、創(chuàng)建工作區(qū),然后登錄工作區(qū)。
- 點(diǎn)擊頂部的+ (添加項(xiàng)目)按鈕添加新項(xiàng)目。為項(xiàng)目命名,然后單擊創(chuàng)建 API 項(xiàng)目。
步驟 2:輸入 API 概覽信息
在本部分中,您將填充 API 概述部分中的字段,其中包括版本、名稱(chēng)、說(shuō)明、安全性、聯(lián)系人、許可證和其他一般詳細(xì)信息。對(duì)于本教程,我們準(zhǔn)備了示例信息,以便您輕松插入 Stoplight 編輯器。(注意:在藍(lán)色可擴(kuò)展部分中的示例信息中,對(duì)于沒(méi)有名稱(chēng)的字段,標(biāo)題位于 [括號(hào)] 中。)
要填充 API 概述:
- 在 Stoplight 側(cè)欄中,單擊API 概述。
- 使用下面灰色部分提供的信息在每個(gè)表單字段中輸入信息
步驟 3:輸入路徑和參數(shù)信息
現(xiàn)在輸入路徑和參數(shù)信息:
- 在側(cè)欄中,右鍵單擊“路徑”文件夾并選擇“新建路徑”。
- 輸入天氣并按回車(chē)鍵。
默認(rèn)情況下,Stoplight 會(huì)為天氣端點(diǎn)創(chuàng)建一個(gè) GET 操作。在我們的例子中,這很有效,因?yàn)榇硕它c(diǎn)有一個(gè) GET 端點(diǎn)。但如果沒(méi)有,您可以單擊其他可用操作來(lái)創(chuàng)建這些操作的詳細(xì)信息。
您可以刪除默認(rèn)/用戶/{用戶ID}和/用戶和端點(diǎn)。右鍵單擊每個(gè)端點(diǎn)并選擇刪除路徑。
- 在主窗口(不是側(cè)邊欄)中,將路徑的標(biāo)題從“您的 GET 端點(diǎn)”更改為“天氣”。
- 點(diǎn)擊左上角的標(biāo)簽按鈕,添加一個(gè)名為“天氣端點(diǎn)”的標(biāo)簽。
步驟 4:了解如何重用參數(shù)
OpenAPI 規(guī)范允許您通過(guò)將信息存儲(chǔ)在成分屬性。在 Stoplight 編輯器中,您可以通過(guò)在側(cè)欄的“參數(shù)”部分輸入?yún)?shù)信息來(lái)重復(fù)使用參數(shù)。(在后臺(tái)代碼中,這些信息存儲(chǔ)在成分。
為了了解其工作原理,讓我們重新使用其中一個(gè)查詢參數(shù)。
要重新使用參數(shù):
- 右鍵單擊側(cè)邊欄左下角的“參數(shù)”文件夾,然后選擇“新建查詢參數(shù)”。 (將顯示類(lèi)似于查詢參數(shù)部分的參數(shù)部分。)
- 輸入lon并按回車(chē)鍵。
- 填充隆此處的參數(shù)使用與之前相同的信息。
- 返回到天氣 GET 端點(diǎn)中輸入的上一個(gè)查詢參數(shù)部分隆參數(shù),然后單擊該參數(shù)的參考按鈕 參考按鈕。
- 搜索“lon”并選擇它。
- 當(dāng)您將參數(shù)鏈接到引用時(shí),圖標(biāo)將變?yōu)榧t色。
- 切換到代碼編輯器并搜索隆。您現(xiàn)在將看到對(duì)組件的引用
步驟 5:輸入響應(yīng)和響應(yīng)架構(gòu)信息
作為此端點(diǎn)的最后一步,您需要輸入響應(yīng)信息。響應(yīng)不僅包括示例響應(yīng),還包括描述響應(yīng)的架構(gòu)。架構(gòu)描述了響應(yīng)中的所有可能值、它們的數(shù)據(jù)類(lèi)型以及這些值是否是必需的。
要在 Stoplight 中輸入響應(yīng)信息:
- 在端點(diǎn)的參數(shù)部分下方,單擊+ Response按鈕??。然后單擊此展開(kāi)的 Response 部分中出現(xiàn)的+ Add Body按鈕。
- 在 Schema 選項(xiàng)卡上,單擊從 JSON 生成。
在這里,您將體驗(yàn)到 Stoplight 編輯器中最酷的功能之一。編輯器將自動(dòng)根據(jù)示例 JSON 響應(yīng)構(gòu)建響應(yīng)架構(gòu)。
- 復(fù)制下面的示例回復(fù)。
- 將您復(fù)制的 JSON 粘貼到灰色區(qū)域中,其中顯示“在下面粘貼或?qū)懸粋€(gè) JSON 示例...”(首先刪除空的花括號(hào),然后粘貼您的示例。)
- 單擊“生成”。Stoplight 會(huì)為您構(gòu)建架構(gòu)!
- 添加有關(guān)響應(yīng)元素的更多詳細(xì)信息:?jiǎn)螕裘總€(gè)屬性旁邊的“描述”并添加描述。單擊“其他屬性”并在示例字段中添加示例。
步驟 6:預(yù)覽、測(cè)試和發(fā)布輸出
您已完成創(chuàng)建 OpenAPI 規(guī)范,因此讓我們預(yù)覽、測(cè)試和發(fā)布測(cè)試文檔:
- 單擊右上角的預(yù)覽按鈕。
- 在側(cè)欄中,選擇/weather端點(diǎn)。
- 點(diǎn)擊屏幕頂部附近的“試用”選項(xiàng)卡。(請(qǐng)參閱下面的說(shuō)明 - 由于 API 的 CORS 限制,此功能現(xiàn)在無(wú)法使用。)
- 輸入您的 API 密鑰應(yīng)用程序ID參數(shù)。有關(guān)獲取 OpenWeatherMap API 密鑰的詳細(xì)信息,請(qǐng)參閱獲取 OpenWeatherMap API 密鑰。(您也可以輸入下圖所示的 API 密鑰。它不是文本,因?yàn)槿魏我晕谋拘问酱蛴〉?API 密鑰都會(huì)被供應(yīng)商利用,然后被禁用。)
- 輸入你的郵政編碼壓縮參數(shù)(例如 98058)。您可能需要滾動(dòng)才能找到 zip 參數(shù),因?yàn)樗鼈儼醋帜疙樞蚺判?。屏幕?yīng)如下所示
指南詳情地址:https://stoplight.io/getting-started-with-stoplight






設(shè)計(jì)優(yōu)先。開(kāi)發(fā)更好。Stoplight是一個(gè)協(xié)作 API 設(shè)計(jì)平臺(tái),可讓您構(gòu)建出色的 API 并創(chuàng)建可擴(kuò)展的 API 程序,以推動(dòng)創(chuàng)新。
加入我們的團(tuán)隊(duì)
我們對(duì) API 和員工充滿熱情。查看我們母公司SmartBear.com上的職位空缺。