Stoplight Studio是一款功能強大的api設計開發(fā)軟件，可為您提供更好的組織，記錄和管理API的方法。簡而言之，Stoplight為您提供了一個全面而可靠的平臺，用于記錄，測試，共享，發(fā)布和分析API，基本上涵蓋了API的所有預生產(chǎn)步驟。您可以通過導入現(xiàn)有的OpenAPI，RAML或Postman API集合進行開始，或者從頭開始創(chuàng)建一個新集合，同時，還可以實現(xiàn)自動化流程以及運行測試方案。總的來說，Stoplight Studio為您帶來了一套完善的api設計開發(fā)環(huán)境，有需要的朋友趕緊下載吧！

軟件功能

　　強大的OpenAPI v2和v3可視編輯器

　　從頭開始快速高效地設計API。Stoplight Studio縮短了學習曲線，因此您無需成為OpenAPI專家即可創(chuàng)建一流的API設計。描述端點，標頭，主體，多個響應，查詢字符串參數(shù)，共享模型和示例，以及更多有關復雜API的信息。

　　即時模擬服務器

　　通過我們由Prism提供支持的集成式即時Mock服務器，立即對您的API設計進行原型設計和協(xié)作。模擬API模擬了真實API的行為，從而允許您對API設計進行協(xié)作和反饋。自動更新以匹配您的API設計。一次模擬一個或多個API。

　　使用OpenAPI和Markdown生成API文檔

　　在幾分鐘內(nèi)創(chuàng)建API文檔。將OpenAPI文檔與Markdown結合在一起，為您的組織創(chuàng)建健壯的，可搜索的內(nèi)部和外部API文檔。

　　OpenAPI Linting和API樣式指南

　　詢問100位API設計師，什么才是好的API設計，您將獲得101個答案，但是大多數(shù)開發(fā)人員真正想要的只是一致性。使用API樣式指南可以減少決策制定并提高所有團隊的一致性。

　　借助由Spectral提供支持的內(nèi)置Linting和API樣式指南，Stoplight Studio可以提高API的質量。您可以使用默認樣式指南，對其進行擴展或編寫一個與您組織的樣式指南相匹配的樣式（Studio中即將推出）。

軟件特色

　　只需幾秒鐘即可在所有關鍵操作系統(tǒng)上安裝

　　遵循簡化的基于向導的安裝程序，可以以最小的麻煩量安裝該應用程序。我們應該指出，Stoplight還隨附了適用于其他流行OS（即macOS和Linux）的配套應用。

　　如預期的那樣，您需要使用您的官方Stoplight憑據(jù)登錄或使用現(xiàn)有的GitHub帳戶創(chuàng)建一個新帳戶。

　　完整且極為用戶友好的API管理解決方案

　　關于應用程序的用戶界面，除了它具有經(jīng)過深思熟慮和現(xiàn)代布局的事實以外，沒有太多要說的了。主窗口分為兩個主要部分，即左側的工具欄，使您可以訪問應用程序的不言自明的部分，即“主頁”，“工作區(qū)設置”，“ API設置”和各種模塊，以及右側的實際編輯部分。

　　借助此實用工具，大大改善了使用API的方式

　　考慮到所有因素，Stoplight Studio是一個功能強大且現(xiàn)代的實用程序，它可以借助其四個內(nèi)置工具（即API設計器，托管文檔）來覆蓋整個API開發(fā)輪，從而改善您使用API的方式。

安裝方法

　　1、雙擊安裝程序“stoplightstudio1.13.1.exe”開始進行安裝。

　　2、正在安裝Stoplight Studio，請稍后。

　　3、安裝完成后，自動打開登錄界面，您可以輸入賬號進行登錄。

使用說明

　　1.打開Stoplight Studio

　　Stoplight Studio的打開頁面包含三個選項：創(chuàng)建一個新的個人項目，打開Git項目和打開現(xiàn)有文件夾。

　　2.創(chuàng)建一個新的個人項目

　　通過輸入名稱來創(chuàng)建新的個人項目，選擇“ 包括教程文件”，然后單擊“ 創(chuàng)建”。

　　“包含教程文件”將使用示例文件填充您的項目，以幫助您入門

　　創(chuàng)建新的個人項目后，首先會看到的是左側的APIs文件樹，而設計面板則占據(jù)了右側的大部分屏幕空間。

　　左側的文件樹是存儲所有Stoplight的設計文件（API規(guī)范：端點，模型，路徑等）的地方，主面板包含目錄，API設計GUI，讀取視圖和寫入視圖。

　　2.目錄結構

　　Studio對于API文件和文檔文件應存放的位置有一些約定。

　　了解Studio目錄結構。

　　3.選擇文檔

　　在Studio中，選擇文件樹的“ 文檔”選項卡，以從API Design工作區(qū)切換到文檔工作區(qū)。在這里可以創(chuàng)建，管理，修改和刪除所有與文檔相關的文件（Markdown文件和圖像文件）。由于您選擇了“包括教程文件”，因此左側的文件樹將由兩個文件夾填充：Markdown和Welcome，以及Assets文件夾：Images。

　　4.修改現(xiàn)有的Markdown文件

　　了解如何創(chuàng)建新的Markdown文件

　　打開Markdown文件夾，然后選擇Markdown基礎。主面板將切換到Markdown編輯器，您可以在其中修改現(xiàn)有內(nèi)容并創(chuàng)建新內(nèi)容。選擇保存以使更改永久生效。您可以通過選擇主面板右上角切換中的“讀取視圖”來切換到“讀取視圖”以預覽所選文件。

　　5.文檔預覽（僅適用于Web App）

　　要完整預覽文檔，請選擇Web應用程序右上方的Docs開關。

新版功能

　　使用Stoplight Studio在幾分鐘內(nèi)設計API

　　授權技術和非技術利益相關者使用直觀的用戶界面在OpenAPI和JSON Schema中創(chuàng)建API設計并進行協(xié)作。使用即時模擬服務器來測試設計并獲得早期反饋。

　　創(chuàng)造美好的開發(fā)者體驗

　　通過向內(nèi)部和外部開發(fā)人員提供始終最新的交互式文檔，教程和代碼示例來推動API的采用。

　　輕松地擴展

　　無論您是使用幾個API和協(xié)作者，還是要管理大型API程序，我們都使共享API，跟蹤更改，管理依賴關系以及創(chuàng)建樣式指南變得輕而易舉。

　　只需連接您的Git倉庫，我們將確保一切都保持最新狀態(tài)。

更新日志

將Spectral升級到v5.5.0-beta8。

修復了標記代碼塊的不正確渲染。

修正從包含循環(huán)引用的OpenAPI文檔中發(fā)送HTTP請求時的崩潰。

常見問題

　　我可以使用Studio桌面連接內(nèi)部服務嗎？

　　是， Studio桌面應用程序是完全脫機的應用程序，可用于直接連接公共互聯(lián)網(wǎng)無法訪問的服務。

　　這包括以下服務：

　　內(nèi)部Git存儲庫（Github Enterprise，GitLab，Bitbucket Server等）

　　單一登錄（SSO）和其他身份提供者，只能從公司網(wǎng)絡內(nèi)部訪問

　　僅可從VPN或內(nèi)部網(wǎng)絡訪問的服務

　　將Studio桌面與托管的Stoplight配對

　　僅僅因為無法從Internet訪問內(nèi)部資源，并不意味著Stoplight托管的SaaS不是可行的選擇。下圖說明了使用Studio桌面應用程序時的網(wǎng)絡通信流程。

　　上圖說明，隨著對內(nèi)部Git VCS的提交，Stoplight CLI可以用于將相關更改推送到Stoplight。這樣可以確保對API或文檔的任何更改（即使是發(fā)生在防火墻后面的更改）也始終可以立即更新，從而使您可以充分利用Stoplight的托管產(chǎn)品，而無需內(nèi)部部署。

　　您的VCS或SSO提供商可以從公共Internet訪問嗎？

　　Stoplight需要訪問任何必要的VCS（Github，GitLab等）或SSO（SAML，LDAP）服務才能正常運行。如果無法從外部訪問這些服務，則您可能無法認證用戶，并確保您的Stoplight文檔是最新的。

　　如果是這種情況，我們建議將Stoplight的IP地址范圍添加到防火墻白名單中，以確保Stoplight可以連接到您的內(nèi)部系統(tǒng)。您可以在此處找到所需的IP范圍。

　　是否有任何使用TLS證書的服務是自簽名的，還是由內(nèi)部CA簽名的？

　　許多組織使用內(nèi)部CA（證書頒發(fā)機構）來簽署內(nèi)部服務和API使用的TLS證書。這意味著需要將任何外部服務（例如Stoplight）配置為信任這些服務公開的證書，否則這些證書將不會被信任。

　　在這種情況下，請使用根CA簽名證書與support@stoplight.io聯(lián)系，以便可以正確配置您的工作區(qū)。

　　是否未公開注冊任何內(nèi)部服務域或DNS記錄？

　　許多組織使用僅在內(nèi)部DNS解析器中注冊的域/主機名（例如，“ git.internal.example.com”）。盡管這對于內(nèi)部連接的任何人都很好，但是這使得單獨使用名稱無法進行外部訪問，尤其是在與SSL要求配對時。

　　在這種情況下，請注冊任何相關服務（VCS，SSO）的公共DNS記錄，以確保可以適當?shù)貜腟toplight路由請求，并且可以正確驗證SSL證書。