 |
stoplight協(xié)作平臺
專用API
【更新時間: 2024.06.25】
Stoplight 是一個協(xié)作平臺，為您的團隊提供貫穿 API 生命周期的工具，幫助他們構(gòu)建 高效優(yōu)質(zhì) API。
每月39 美元
去服務(wù)商官網(wǎng)采購>
|
瀏覽次數(shù)
106
采購人數(shù)
0
試用次數(shù)
0
SLA: N/A
響應(yīng): N/A
適用于個人&企業(yè)
試用
收藏
×
完成
取消
×
書簽名稱
確定
|
- API詳情
- 定價
- 使用指南
- 常見 FAQ
- 關(guān)于我們
- 相關(guān)推薦
什么是stoplight協(xié)作平臺?
Stoplight 以現(xiàn)代 API 工作流程為設(shè)計理念，提供直觀的界面和周到的功能，為您的整個 API 設(shè)計生命周期提供支持。Stoplight 平臺讓技術(shù)和非技術(shù)利益相關(guān)者能夠使用直觀的界面在 OpenAPI 和 JSON Schema 中創(chuàng)建和協(xié)作 API 設(shè)計。免費開始使用或選擇適合您和您的組織的計劃 - 從個人到專業(yè)團隊選項。無論您使用一個還是 1,000 個 API，與內(nèi)部、外部或混合協(xié)作者合作，我們都讓共享 API、跟蹤更改、管理依賴項和使用樣式指南變得輕而易舉。
什么是stoplight協(xié)作平臺接口？
stoplight協(xié)作平臺有哪些核心功能？
 |
 |
 |
創(chuàng)建成功的 API 程序對您的 API 程序采取主動的方法，以有效地創(chuàng)造一致的生產(chǎn)力并避免延誤和超支的負(fù)面影響。 |
降低風(fēng)險并提高投資回報率聯(lián)網(wǎng)軟件對于當(dāng)今的消費者而言必不可少。避免造成巨大風(fēng)險和投資回報率降低的混亂開發(fā)工作。 |
設(shè)計你的 API通過查看整個 API 目錄、OAS 標(biāo)準(zhǔn)以及重用模型和組件的能力，每次都可以輕松創(chuàng)建高質(zhì)量的 API。 |
stoplight協(xié)作平臺的核心優(yōu)勢是什么？
 |
 |
 |
|
輕松設(shè)計和記錄 API
使用可視化編輯器創(chuàng)建、原型化和共享 OpenAPI 描述和 JSON 模式。使用可編輯的 markdown 自動生成世界一流的文檔。 |
鼓勵一致性和重用
利用一流的指導(dǎo)方針和組件庫優(yōu)化小型和大型 API 團隊的開發(fā)。輕松訪問樣式指南和可重復(fù)使用的組件。 |
增強協(xié)作
在 Git 上的中央事實源中協(xié)作完成 API 設(shè)計和文檔。在 Stoplight 編輯器中跟蹤設(shè)計評論。將評論集成到您當(dāng)前的工作流程中。 |
 |
 |
 |
|
具有令人愉悅的開發(fā)人員體驗的 API 文檔
從您最喜歡的 VCS 創(chuàng)建最新 API 設(shè)計資產(chǎn)集合，例如 OpenAPI 描述、JSON 架構(gòu)和文檔。搜索、重用和管理 API。 |
維護中心事實來源
使用中央存儲庫構(gòu)建內(nèi)部和外部 API，用于存儲所有 API 設(shè)計資產(chǎn)。輕松發(fā)現(xiàn)系統(tǒng)中現(xiàn)有的 OpenAPI 規(guī)范，并在 Stoplight 平臺內(nèi)進行管理。 |
由 OpenAPI 支持的模擬服務(wù)器可加快開發(fā)速度
讓您的前端和后端團隊使用托管的模擬服務(wù)器進行開發(fā)。Stoplight 通過根據(jù) API 描述創(chuàng)建模擬服務(wù)器來補充您的工作流程。 |
在哪些場景會用到stoplight協(xié)作平臺？
-
API設(shè)計協(xié)作：當(dāng)團隊需要共同設(shè)計、審查、修改和記錄API時，Stoplight平臺提供了直觀的工具和界面，使得技術(shù)和非技術(shù)利益相關(guān)者都能夠參與API的設(shè)計過程。
-
模擬服務(wù)器加速開發(fā)：對于需要模擬API響應(yīng)以支持前端和后端開發(fā)的團隊，Stoplight的模擬服務(wù)器功能可以根據(jù)API描述快速創(chuàng)建模擬環(huán)境，從而加速開發(fā)過程。
-
企業(yè)規(guī)模API管理：對于大型企業(yè)或開發(fā)團隊，Stoplight Enterprise提供了企業(yè)級API管理能力，如跨團隊擴展API設(shè)計工作、生成交互式文檔、在中央存儲庫中管理API設(shè)計資產(chǎn)、執(zhí)行標(biāo)準(zhǔn)以降低風(fēng)險等。
-
API測試與驗證：Stoplight平臺可以與其他測試工具集成，幫助團隊在API設(shè)計和開發(fā)過程中進行驗證和測試，確保API的正確性和性能。
-
API發(fā)布與監(jiān)控：一旦API設(shè)計完成并通過測試，Stoplight平臺還可以支持API的發(fā)布和監(jiān)控過程，確保API在生產(chǎn)環(huán)境中穩(wěn)定運行，并收集和分析使用數(shù)據(jù)以進行持續(xù)優(yōu)化。
步驟 1：在 Stoplight 中設(shè)置項目
- 前往https://stoplight.io/welcome
- 按照屏幕上的說明進行注冊、創(chuàng)建工作區(qū)，然后登錄工作區(qū)。
- 點擊頂部的+ （添加項目）按鈕添加新項目。為項目命名，然后單擊創(chuàng)建 API 項目。
步驟 2：輸入 API 概覽信息
在本部分中，您將填充 API 概述部分中的字段，其中包括版本、名稱、說明、安全性、聯(lián)系人、許可證和其他一般詳細信息。對于本教程，我們準(zhǔn)備了示例信息，以便您輕松插入 Stoplight 編輯器。（注意：在藍色可擴展部分中的示例信息中，對于沒有名稱的字段，標(biāo)題位于 [括號] 中。）
要填充 API 概述：
- 在 Stoplight 側(cè)欄中，單擊API 概述。
- 使用下面灰色部分提供的信息在每個表單字段中輸入信息
步驟 3：輸入路徑和參數(shù)信息
現(xiàn)在輸入路徑和參數(shù)信息：
- 在側(cè)欄中，右鍵單擊“路徑”文件夾并選擇“新建路徑”。
- 輸入天氣并按回車鍵。
默認(rèn)情況下，Stoplight 會為天氣端點創(chuàng)建一個 GET 操作。在我們的例子中，這很有效，因為此端點有一個 GET 端點。但如果沒有，您可以單擊其他可用操作來創(chuàng)建這些操作的詳細信息。
您可以刪除默認(rèn)/用戶/{用戶ID}和/用戶和端點。右鍵單擊每個端點并選擇刪除路徑。
- 在主窗口（不是側(cè)邊欄）中，將路徑的標(biāo)題從“您的 GET 端點”更改為“天氣”。
- 點擊左上角的標(biāo)簽按鈕，添加一個名為“天氣端點”的標(biāo)簽。
步驟 4：了解如何重用參數(shù)
OpenAPI 規(guī)范允許您通過將信息存儲在成分屬性。在 Stoplight 編輯器中，您可以通過在側(cè)欄的“參數(shù)”部分輸入?yún)?shù)信息來重復(fù)使用參數(shù)。（在后臺代碼中，這些信息存儲在成分。
為了了解其工作原理，讓我們重新使用其中一個查詢參數(shù)。
要重新使用參數(shù)：
- 右鍵單擊側(cè)邊欄左下角的“參數(shù)”文件夾，然后選擇“新建查詢參數(shù)”。 （將顯示類似于查詢參數(shù)部分的參數(shù)部分。）
- 輸入lon并按回車鍵。
- 填充隆此處的參數(shù)使用與之前相同的信息。
- 返回到天氣 GET 端點中輸入的上一個查詢參數(shù)部分隆參數(shù)，然后單擊該參數(shù)的參考按鈕 參考按鈕。
- 搜索“lon”并選擇它。
- 當(dāng)您將參數(shù)鏈接到引用時，圖標(biāo)將變?yōu)榧t色。
- 切換到代碼編輯器并搜索隆。您現(xiàn)在將看到對組件的引用
步驟 5：輸入響應(yīng)和響應(yīng)架構(gòu)信息
作為此端點的最后一步，您需要輸入響應(yīng)信息。響應(yīng)不僅包括示例響應(yīng)，還包括描述響應(yīng)的架構(gòu)。架構(gòu)描述了響應(yīng)中的所有可能值、它們的數(shù)據(jù)類型以及這些值是否是必需的。
要在 Stoplight 中輸入響應(yīng)信息：
- 在端點的參數(shù)部分下方，單擊+ Response按鈕??。然后單擊此展開的 Response 部分中出現(xiàn)的+ Add Body按鈕。
- 在 Schema 選項卡上，單擊從 JSON 生成。
在這里，您將體驗到 Stoplight 編輯器中最酷的功能之一。編輯器將自動根據(jù)示例 JSON 響應(yīng)構(gòu)建響應(yīng)架構(gòu)。
- 復(fù)制下面的示例回復(fù)。
- 將您復(fù)制的 JSON 粘貼到灰色區(qū)域中，其中顯示“在下面粘貼或?qū)懸粋€ JSON 示例...”（首先刪除空的花括號，然后粘貼您的示例。）
- 單擊“生成”。Stoplight 會為您構(gòu)建架構(gòu)！
- 添加有關(guān)響應(yīng)元素的更多詳細信息：單擊每個屬性旁邊的“描述”并添加描述。單擊“其他屬性”并在示例字段中添加示例。
步驟 6：預(yù)覽、測試和發(fā)布輸出
您已完成創(chuàng)建 OpenAPI 規(guī)范，因此讓我們預(yù)覽、測試和發(fā)布測試文檔：
- 單擊右上角的預(yù)覽按鈕。
- 在側(cè)欄中，選擇/weather端點。
- 點擊屏幕頂部附近的“試用”選項卡。（請參閱下面的說明 - 由于 API 的 CORS 限制，此功能現(xiàn)在無法使用。）
- 輸入您的 API 密鑰應(yīng)用程序ID參數(shù)。有關(guān)獲取 OpenWeatherMap API 密鑰的詳細信息，請參閱獲取 OpenWeatherMap API 密鑰。（您也可以輸入下圖所示的 API 密鑰。它不是文本，因為任何以文本形式打印的 API 密鑰都會被供應(yīng)商利用，然后被禁用。）
- 輸入你的郵政編碼壓縮參數(shù)（例如 98058）。您可能需要滾動才能找到 zip 參數(shù)，因為它們按字母順序排序。屏幕應(yīng)如下所示
指南詳情地址：https://stoplight.io/getting-started-with-stoplight
設(shè)計優(yōu)先。開發(fā)更好。Stoplight是一個協(xié)作 API 設(shè)計平臺，可讓您構(gòu)建出色的 API 并創(chuàng)建可擴展的 API 程序，以推動創(chuàng)新。
加入我們的團隊
我們對 API 和員工充滿熱情。查看我們母公司SmartBear.com上的職位空缺。
步驟 1：在 Stoplight 中設(shè)置項目
- 前往https://stoplight.io/welcome
- 按照屏幕上的說明進行注冊、創(chuàng)建工作區(qū)，然后登錄工作區(qū)。
- 點擊頂部的+ （添加項目）按鈕添加新項目。為項目命名，然后單擊創(chuàng)建 API 項目。
步驟 2：輸入 API 概覽信息
在本部分中，您將填充 API 概述部分中的字段，其中包括版本、名稱、說明、安全性、聯(lián)系人、許可證和其他一般詳細信息。對于本教程，我們準(zhǔn)備了示例信息，以便您輕松插入 Stoplight 編輯器。（注意：在藍色可擴展部分中的示例信息中，對于沒有名稱的字段，標(biāo)題位于 [括號] 中。）
要填充 API 概述：
- 在 Stoplight 側(cè)欄中，單擊API 概述。
- 使用下面灰色部分提供的信息在每個表單字段中輸入信息
步驟 3：輸入路徑和參數(shù)信息
現(xiàn)在輸入路徑和參數(shù)信息：
- 在側(cè)欄中，右鍵單擊“路徑”文件夾并選擇“新建路徑”。
- 輸入天氣并按回車鍵。
默認(rèn)情況下，Stoplight 會為天氣端點創(chuàng)建一個 GET 操作。在我們的例子中，這很有效，因為此端點有一個 GET 端點。但如果沒有，您可以單擊其他可用操作來創(chuàng)建這些操作的詳細信息。
您可以刪除默認(rèn)/用戶/{用戶ID}和/用戶和端點。右鍵單擊每個端點并選擇刪除路徑。
- 在主窗口（不是側(cè)邊欄）中，將路徑的標(biāo)題從“您的 GET 端點”更改為“天氣”。
- 點擊左上角的標(biāo)簽按鈕，添加一個名為“天氣端點”的標(biāo)簽。
步驟 4：了解如何重用參數(shù)
OpenAPI 規(guī)范允許您通過將信息存儲在成分屬性。在 Stoplight 編輯器中，您可以通過在側(cè)欄的“參數(shù)”部分輸入?yún)?shù)信息來重復(fù)使用參數(shù)。（在后臺代碼中，這些信息存儲在成分。
為了了解其工作原理，讓我們重新使用其中一個查詢參數(shù)。
要重新使用參數(shù)：
- 右鍵單擊側(cè)邊欄左下角的“參數(shù)”文件夾，然后選擇“新建查詢參數(shù)”。 （將顯示類似于查詢參數(shù)部分的參數(shù)部分。）
- 輸入lon并按回車鍵。
- 填充隆此處的參數(shù)使用與之前相同的信息。
- 返回到天氣 GET 端點中輸入的上一個查詢參數(shù)部分隆參數(shù)，然后單擊該參數(shù)的參考按鈕 參考按鈕。
- 搜索“lon”并選擇它。
- 當(dāng)您將參數(shù)鏈接到引用時，圖標(biāo)將變?yōu)榧t色。
- 切換到代碼編輯器并搜索隆。您現(xiàn)在將看到對組件的引用
步驟 5：輸入響應(yīng)和響應(yīng)架構(gòu)信息
作為此端點的最后一步，您需要輸入響應(yīng)信息。響應(yīng)不僅包括示例響應(yīng)，還包括描述響應(yīng)的架構(gòu)。架構(gòu)描述了響應(yīng)中的所有可能值、它們的數(shù)據(jù)類型以及這些值是否是必需的。
要在 Stoplight 中輸入響應(yīng)信息：
- 在端點的參數(shù)部分下方，單擊+ Response按鈕??。然后單擊此展開的 Response 部分中出現(xiàn)的+ Add Body按鈕。
- 在 Schema 選項卡上，單擊從 JSON 生成。
在這里，您將體驗到 Stoplight 編輯器中最酷的功能之一。編輯器將自動根據(jù)示例 JSON 響應(yīng)構(gòu)建響應(yīng)架構(gòu)。
- 復(fù)制下面的示例回復(fù)。
- 將您復(fù)制的 JSON 粘貼到灰色區(qū)域中，其中顯示“在下面粘貼或?qū)懸粋€ JSON 示例...”（首先刪除空的花括號，然后粘貼您的示例。）
- 單擊“生成”。Stoplight 會為您構(gòu)建架構(gòu)！
- 添加有關(guān)響應(yīng)元素的更多詳細信息：單擊每個屬性旁邊的“描述”并添加描述。單擊“其他屬性”并在示例字段中添加示例。
步驟 6：預(yù)覽、測試和發(fā)布輸出
您已完成創(chuàng)建 OpenAPI 規(guī)范，因此讓我們預(yù)覽、測試和發(fā)布測試文檔：
- 單擊右上角的預(yù)覽按鈕。
- 在側(cè)欄中，選擇/weather端點。
- 點擊屏幕頂部附近的“試用”選項卡。（請參閱下面的說明 - 由于 API 的 CORS 限制，此功能現(xiàn)在無法使用。）
- 輸入您的 API 密鑰應(yīng)用程序ID參數(shù)。有關(guān)獲取 OpenWeatherMap API 密鑰的詳細信息，請參閱獲取 OpenWeatherMap API 密鑰。（您也可以輸入下圖所示的 API 密鑰。它不是文本，因為任何以文本形式打印的 API 密鑰都會被供應(yīng)商利用，然后被禁用。）
- 輸入你的郵政編碼壓縮參數(shù)（例如 98058）。您可能需要滾動才能找到 zip 參數(shù)，因為它們按字母順序排序。屏幕應(yīng)如下所示
指南詳情地址：https://stoplight.io/getting-started-with-stoplight
設(shè)計優(yōu)先。開發(fā)更好。Stoplight是一個協(xié)作 API 設(shè)計平臺，可讓您構(gòu)建出色的 API 并創(chuàng)建可擴展的 API 程序，以推動創(chuàng)新。
加入我們的團隊
我們對 API 和員工充滿熱情。查看我們母公司SmartBear.com上的職位空缺。
