Stoplight Studio(api设计开发软件) v1.13.1 官方版

　　Stoplight Studio是一款API设计工具，常与OpenAPI规范一起用来组织和设计标准的HTTP API；这款软件拥有直观的可视化操作界面，使用简单，它允许开发者无需编写任何代码就可以快速且高效的进行一些复杂API的建模工作；软件支持即时模拟服务器，通过这项功能，用户可以及时获得有关原型的反馈；Stoplight Studio使初学者缩短了学习API设计的时间周期，直接通过程序内置的描述端点，标头，主体，多个响应，查询字符串参数，共享模型等等就可以轻松创建一个一流的API设计项目。

软件功能

　　增加API采用率

　　通过发布始终最新的交互式文档，教程和代码示例，帮助内部和外部用户快速发现，学习并与您的API集成。

　　交互式文档

　　生成始终同步的综合文档。通过从API文档中试用API端点，帮助开发人员更快地在API中发现价值。

　　代码样本

　　通过提供流行语言（例如Curl，Python，Ruby，Java等）的代码示例，为开发人员和启动集成工作带来繁重的工作。

　　主题模板

　　使用多种主题选项构建适合您品牌的开发人员中心，并将其放在您的域中即可轻松找到它。

　　强大的搜索

　　开发人员可以通过集线器范围内的搜索轻松找到端点，参考文档和架构。

软件特色

　　技术知识库

　　模型和技术文档都组织成一个漂亮的，可搜索的UI，所有这些都来自Git存储库。

　　API设计

　　使用Stoplight Studio，设计速度提高了10倍，可视化API设计器已无缝集成到工作区和Git工作流程中。

　　共享技术

　　与您自己的域中的外部利益相关者共享全部或部分技术知识库。

　　即时模拟服务器

　　自动为您的技术知识库中的每个API提供最新的模拟服务器。

　　无需编程技术

　　无需编写任何代码，即可比以往更快地对复杂的API进行建模，同时使用我们的即时模拟服务器获得有关原型的反馈。

使用方法

　　克隆第一个项目

　　使用Studio启动并运行的最快方法是克隆现有的Git存储库。如果您是从Studio桌面版本运行的，那么就像在计算机上选择一个已经存在存储库的位置一样简单。如果您是通过浏览器运行的，则可以简单地将HTTP Git URL粘贴到要添加的任何Github存储库中。

　　将您的Git存储库的URL粘贴到Studio登陆屏幕上的“打开Git项目”界面中，然后单击“克隆”以打开项目。

　　无法克隆？

　　如果您尚未将Stoplight帐户与源代码管理提供程序帐户关联，则可能会看到与以下类似的“ Git身份验证”错误。

　　如果发生这种情况，您所需要做的就是单击“连接...”按钮以登录外部服务提供商。

　　创建一个API

　　要创建新的API，请使用项目名称旁边的菜单，然后选择“ API”。

　　您可以从那里命名您的API，然后选择设置规范版本（OpenAPI v2或v3）和存储格式（JSON或YAML）。

　　在确定规范版本或格式之前，请确保与您可能要与之集成的其他任何供应商或工具进行核对。虽然OpenAPI版本3可能是最新的可用版本，但是某些工具和供应商尚未提供完整的支持。

　　单击“创建”后，将创建一个新的API描述文档并将其添加到项目中。然后，您可以在此处设置有关API的全局信息，并开始添加您的第一个操作。

　　创建模型

　　要创建模型，请在左侧边栏的“模型”标题下单击鼠标右键，选择“新建模型”，然后输入要创建的模型的名称。创建后，您可以使用在“表单”视图中显示的JSON模式编辑器向模型添加和自定义属性。

　　创建一个端点

　　要创建端点，请在左侧边栏中的“路径”标题下单击鼠标右键，选择“新建路径”，然后输入所需的路径。

　　请注意，OpenAPI允许通过将元素包装在方括号中来指定路径模板，即“ {myElement}”。这使您可以在路径中指定在运行时将替换的参数。例如，如果要创建“用户”端点，则可以将路径指定为“ / users / {userName}”，该路径告诉OpenAPI运行时将用“ userName”代替真实的用户名。

　　制作请求和响应

　　虽然有一个端点很好，但是除非您实际接受并返回数据，否则它不会做很多事情。查看端点时，可以通过在“表单”视图中向下滚动并添加安全设置，标头值，查询参数和请求正文来修改请求和响应结构。再往下看，您将能够修改和添加响应，包括使用JSON模式编辑器添加响应标头和修改响应对象。