Stoplight Studio(api设计开发软件)

　　Stoplight Studio是一款功能强大的api设计开发软件，可为您提供更好的组织，记录和管理API的方法。简而言之，Stoplight为您提供了一个全面而可靠的平台，用于记录，测试，共享，发布和分析API，基本上涵盖了API的所有预生产步骤。您可以通过导入现有的OpenAPI，RAML或Postman API集合进行开始，或者从头开始创建一个新集合，同时，还可以实现自动化流程以及运行测试方案。总的来说，Stoplight Studio为您带来了一套完善的api设计开发环境，有需要的朋友赶紧下载吧！

软件功能

　　强大的OpenAPI v2和v3可视编辑器

　　从头开始快速高效地设计API。Stoplight Studio缩短了学习曲线，因此您无需成为OpenAPI专家即可创建一流的API设计。描述端点，标头，主体，多个响应，查询字符串参数，共享模型和示例，以及更多有关复杂API的信息。

　　即时模拟服务器

　　通过我们由Prism提供支持的集成式即时Mock服务器，立即对您的API设计进行原型设计和协作。模拟API模拟了真实API的行为，从而允许您对API设计进行协作和反馈。自动更新以匹配您的API设计。一次模拟一个或多个API。

　　使用OpenAPI和Markdown生成API文档

　　在几分钟内创建API文档。将OpenAPI文档与Markdown结合在一起，为您的组织创建健壮的，可搜索的内部和外部API文档。

　　OpenAPI Linting和API样式指南

　　询问100位API设计师，什么才是好的API设计，您将获得101个答案，但是大多数开发人员真正想要的只是一致性。使用API样式指南可以减少决策制定并提高所有团队的一致性。

　　借助由Spectral提供支持的内置Linting和API样式指南，Stoplight Studio可以提高API的质量。您可以使用默认样式指南，对其进行扩展或编写一个与您组织的样式指南相匹配的样式（Studio中即将推出）。

软件特色

　　只需几秒钟即可在所有关键操作系统上安装

　　遵循简化的基于向导的安装程序，可以以最小的麻烦量安装该应用程序。我们应该指出，Stoplight还随附了适用于其他流行OS（即macOS和Linux）的配套应用。

　　如预期的那样，您需要使用您的官方Stoplight凭据登录或使用现有的GitHub帐户创建一个新帐户。

　　完整且极为用户友好的API管理解决方案

　　关于应用程序的用户界面，除了它具有经过深思熟虑和现代布局的事实以外，没有太多要说的了。主窗口分为两个主要部分，即左侧的工具栏，使您可以访问应用程序的不言自明的部分，即“主页”，“工作区设置”，“ API设置”和各种模块，以及右侧的实际编辑部分。

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

　　考虑到所有因素，Stoplight Studio是一个功能强大且现代的实用程序，它可以借助其四个内置工具（即API设计器，托管文档）来覆盖整个API开发轮，从而改善您使用API的方式。

安装方法

　　1、双击安装程序“stoplightstudio1.13.1.exe”开始进行安装。

　　2、正在安装Stoplight Studio，请稍后。

　　3、安装完成后，自动打开登录界面，您可以输入账号进行登录。

使用说明

　　1.打开Stoplight Studio

　　Stoplight Studio的打开页面包含三个选项：创建一个新的个人项目，打开Git项目和打开现有文件夹。

　　2.创建一个新的个人项目

　　通过输入名称来创建新的个人项目，选择“ 包括教程文件”，然后单击“ 创建”。

　　“包含教程文件”将使用示例文件填充您的项目，以帮助您入门

　　创建新的个人项目后，首先会看到的是左侧的APIs文件树，而设计面板则占据了右侧的大部分屏幕空间。

　　左侧的文件树是存储所有Stoplight的设计文件（API规范：端点，模型，路径等）的地方，主面板包含目录，API设计GUI，读取视图和写入视图。

　　2.目录结构

　　Studio对于API文件和文档文件应存放的位置有一些约定。

　　了解Studio目录结构。

　　3.选择文档

　　在Studio中，选择文件树的“ 文档”选项卡，以从API Design工作区切换到文档工作区。在这里可以创建，管理，修改和删除所有与文档相关的文件（Markdown文件和图像文件）。由于您选择了“包括教程文件”，因此左侧的文件树将由两个文件夹填充：Markdown和Welcome，以及Assets文件夹：Images。

　　4.修改现有的Markdown文件

　　了解如何创建新的Markdown文件

　　打开Markdown文件夹，然后选择Markdown基础。主面板将切换到Markdown编辑器，您可以在其中修改现有内容并创建新内容。选择保存以使更改永久生效。您可以通过选择主面板右上角切换中的“读取视图”来切换到“读取视图”以预览所选文件。

　　5.文档预览（仅适用于Web App）

　　要完整预览文档，请选择Web应用程序右上方的Docs开关。

新版功能

　　使用Stoplight Studio在几分钟内设计API

　　授权技术和非技术利益相关者使用直观的用户界面在OpenAPI和JSON Schema中创建API设计并进行协作。使用即时模拟服务器来测试设计并获得早期反馈。

　　创造美好的开发者体验

　　通过向内部和外部开发人员提供始终最新的交互式文档，教程和代码示例来推动API的采用。

　　轻松地扩展

　　无论您是使用几个API和协作者，还是要管理大型API程序，我们都使共享API，跟踪更改，管理依赖关系以及创建样式指南变得轻而易举。

　　只需连接您的Git仓库，我们将确保一切都保持最新状态。

常见问题

　　我可以使用Studio桌面连接内部服务吗？

　　是， Studio桌面应用程序是完全脱机的应用程序，可用于直接连接公共互联网无法访问的服务。

　　这包括以下服务：

　　内部Git存储库（Github Enterprise，GitLab，Bitbucket Server等）

　　单一登录（SSO）和其他身份提供者，只能从公司网络内部访问

　　仅可从VPN或内部网络访问的服务

　　将Studio桌面与托管的Stoplight配对

　　仅仅因为无法从Internet访问内部资源，并不意味着Stoplight托管的SaaS不是可行的选择。下图说明了使用Studio桌面应用程序时的网络通信流程。

　　上图说明，随着对内部Git VCS的提交，Stoplight CLI可以用于将相关更改推送到Stoplight。这样可以确保对API或文档的任何更改（即使是发生在防火墙后面的更改）也始终可以立即更新，从而使您可以充分利用Stoplight的托管产品，而无需内部部署。

　　您的VCS或SSO提供商可以从公共Internet访问吗？

　　Stoplight需要访问任何必要的VCS（Github，GitLab等）或SSO（SAML，LDAP）服务才能正常运行。如果无法从外部访问这些服务，则您可能无法认证用户，并确保您的Stoplight文档是最新的。

　　如果是这种情况，我们建议将Stoplight的IP地址范围添加到防火墙白名单中，以确保Stoplight可以连接到您的内部系统。您可以在此处找到所需的IP范围。

　　是否有任何使用TLS证书的服务是自签名的，还是由内部CA签名的？

　　许多组织使用内部CA（证书颁发机构）来签署内部服务和API使用的TLS证书。这意味着需要将任何外部服务（例如Stoplight）配置为信任这些服务公开的证书，否则这些证书将不会被信任。

　　在这种情况下，请使用根CA签名证书与support@stoplight.io联系，以便可以正确配置您的工作区。

　　是否未公开注册任何内部服务域或DNS记录？

　　许多组织使用仅在内部DNS解析器中注册的域/主机名（例如，“ git.internal.example.com”）。尽管这对于内部连接的任何人都很好，但是这使得单独使用名称无法进行外部访问，尤其是在与SSL要求配对时。

　　在这种情况下，请注册任何相关服务（VCS，SSO）的公共DNS记录，以确保可以适当地从Stoplight路由请求，并且可以正确验证SSL证书。