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

軟件功能

　　強(qiáng)大的OpenAPI v2和v3可視編輯器

　　從頭開(kāi)始快速高效地設(shè)計(jì)API。Stoplight Studio縮短了學(xué)習(xí)曲線，因此您無(wú)需成為OpenAPI專(zhuān)家即可創(chuàng)建一流的API設(shè)計(jì)。描述端點(diǎn)，標(biāo)頭，主體，多個(gè)響應(yīng)，查詢字符串參數(shù)，共享模型和示例，以及更多有關(guān)復(fù)雜API的信息。

　　即時(shí)模擬服務(wù)器

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

　　使用OpenAPI和Markdown生成API文檔

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

　　OpenAPI Linting和API樣式指南

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

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

軟件特色

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

　　遵循簡(jiǎn)化的基于向?qū)У陌惭b程序，可以以最小的麻煩量安裝該應(yīng)用程序。我們應(yīng)該指出，Stoplight還隨附了適用于其他流行OS（即macOS和Linux）的配套應(yīng)用。

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

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

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

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

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

安裝方法

　　1、雙擊安裝程序“stoplightstudio1.13.1.exe”開(kāi)始進(jìn)行安裝。

　　2、正在安裝Stoplight Studio，請(qǐng)稍后。

　　3、安裝完成后，自動(dòng)打開(kāi)登錄界面，您可以輸入賬號(hào)進(jìn)行登錄。

使用說(shuō)明

　　1.打開(kāi)Stoplight Studio

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

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

　　通過(guò)輸入名稱(chēng)來(lái)創(chuàng)建新的個(gè)人項(xiàng)目，選擇“ 包括教程文件”，然后單擊“ 創(chuàng)建”。

　　“包含教程文件”將使用示例文件填充您的項(xiàng)目，以幫助您入門(mén)

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

　　左側(cè)的文件樹(shù)是存儲(chǔ)所有Stoplight的設(shè)計(jì)文件（API規(guī)范：端點(diǎn)，模型，路徑等）的地方，主面板包含目錄，API設(shè)計(jì)GUI，讀取視圖和寫(xiě)入視圖。

　　2.目錄結(jié)構(gòu)

　　Studio對(duì)于API文件和文檔文件應(yīng)存放的位置有一些約定。

　　了解Studio目錄結(jié)構(gòu)。

　　3.選擇文檔

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

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

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

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

　　5.文檔預(yù)覽（僅適用于Web App）

　　要完整預(yù)覽文檔，請(qǐng)選擇Web應(yīng)用程序右上方的Docs開(kāi)關(guān)。

新版功能

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

　　授權(quán)技術(shù)和非技術(shù)利益相關(guān)者使用直觀的用戶界面在OpenAPI和JSON Schema中創(chuàng)建API設(shè)計(jì)并進(jìn)行協(xié)作。使用即時(shí)模擬服務(wù)器來(lái)測(cè)試設(shè)計(jì)并獲得早期反饋。

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

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

　　輕松地?cái)U(kuò)展

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

　　只需連接您的Git倉(cāng)庫(kù)，我們將確保一切都保持最新?tīng)顟B(tài)。

更新日志

將Spectral升級(jí)到v5.5.0-beta8。

修復(fù)了標(biāo)記代碼塊的不正確渲染。

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

常見(jiàn)問(wèn)題

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

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

　　這包括以下服務(wù)：

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

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

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

　　將Studio桌面與托管的Stoplight配對(duì)

　　僅僅因?yàn)闊o(wú)法從Internet訪問(wèn)內(nèi)部資源，并不意味著Stoplight托管的SaaS不是可行的選擇。下圖說(shuō)明了使用Studio桌面應(yīng)用程序時(shí)的網(wǎng)絡(luò)通信流程。

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

　　您的VCS或SSO提供商可以從公共Internet訪問(wèn)嗎？

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

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

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

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

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

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

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

　　在這種情況下，請(qǐng)注冊(cè)任何相關(guān)服務(wù)（VCS，SSO）的公共DNS記錄，以確?？梢赃m當(dāng)?shù)貜腟toplight路由請(qǐng)求，并且可以正確驗(yàn)證SSL證書(shū)。