Stoplight Studio 1.13.2 正式安装版api设计开发工具

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

安装方式：

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

2.正在安装Stoplight Studio，请稍候。

3.安装完成后，登录界面将自动打开，您可以输入您的帐户进行登录。

软件功能：

强大的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.打开Stoplight Studio

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

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

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

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

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

左侧的文件树是所有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开关。

常见问题：

我可以使用Studio Desktop连接到内部服务吗？

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

其中包括以下服务：

内部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签名证书与[email protected]联系，以便您可以正确配置工作区。

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

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

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

新功能：

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

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

创造美好的开发者体验

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

轻松扩展

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

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