Stoplight Studio是Stoplight用于API设计、建模和技术编写的下一代应用程序,Studio的主要目标是丰富而不是取代您现有的工作流程,当在本地运行时,它可以完全脱机工作,文件夹和文件都在您的计算机上,就像您最喜欢的IDE一样,当在浏览器中运行时,网络原生的Git支持可以让你毫不费力地安全有效地使用你现有的仓库。
功能介绍
全面支持OpenAPI v2和v3
Studio的所有功能都完全支持OpenAPI 2和3版本的规范格式。这意味着对OpenAPI规范的两个版本都有完整的验证、嘲讽和建模支持。
Studio喜欢Swagger + OpenAPI
图形化的API设计
基于表单的设计意味着你不需要是一个OpenAPI专家就可以开始。Studio有一个 "写"(代码)模式,具有完整的OpenAPI自动完成功能,还有一个 "读 "模式,用于可视化HTTP操作和模型。
OpenAPI的图形设计
要了解更多关于如何在不编写一行JSON或YAML的情况下快速设计和原型API的信息,请看这里。
JSON模式建模
Studio不只是针对API,你还可以创建和修改独立的JSON Schema文件来存储数据模型。我们有没有提到,这也是由图形界面提供的?不用再寻找匹配的括号或缺失的空格,也不用熟悉JSON Schema的进退。
鼓励重用,避免重复。
当涉及到API建模时,避免重复劳动可能是成功和失败的区别。如果你的所有端点都以略微不同的方式重新创建相同的模型,你怎么能执行一致性呢?(提示,你不能)
Studio的图形化JSON模式编辑器允许您快速找到要引用的模型。
Studio允许您在需要的时候快速、轻松地找到并重用您需要的对象。不再需要为不同的端点重新创建模型,不再需要因为添加了新的字段而更新几十个不同的端点。
要了解更多关于如何利用引用来扩展您的API一致性的信息,请看这里。
技术文档
混合API参考文档和基于Markdown的指南、操作方法、入门信息等。您的所有文档都可以放在同一个项目中。Studio包括一个内置的markdown编辑器,图像管理器,以及将文档发布到Stoplight新的文档平台的能力。
创建漂亮且易于使用的API参考文档
您甚至可以将文件存放在您自己的 Git 仓库中,然后在您准备好展示您的最新和最伟大的作品时发布。
要了解更多关于在Studio中编写技术文档的信息,请看我们的入门指南。
样式指南和验证
使用本机Spectral集成来强制执行正确性和最佳实践,并在创建错误时向您发出警报。
Spectral会验证和过滤您的API,以确保它们的正确性和功能性。
点击错误或警告,您还会看到它们在文档中的确切位置,从而可以轻松地在源头修复错误。
要了解更多关于Spectral的信息,以及验证如何改善您的API设计工作流程,请看这里。
Built-in Mocking
当在本地运行时,Studio将自动为项目中定义的每个API启动本地Prism模拟服务器,并在您更改设计时保持该模拟服务器的更新。
模拟允许你在进入代码之前快速测试你的API的外观和感觉。
要了解更多关于Prism的信息,以及如何使用嘲讽来简化你的API开发流程,请看这里。
自带版本库
由于Studio与你的本地文件系统一起工作,你可以打开你的API项目,并开始添加文档和设计,以及它们所要描述的实际实现。一旦完成,就可以用你最喜欢的Git客户端将其全部检查到Git中。
更新日志
将Spectral升级到v5.5.0-beta8。
修复了标记代码块的不正确渲染。
修正从包含循环引用的OpenAPI文档中发送HTTP请求时的崩溃。
使用方法
1 下载完成后不要在压缩包内运行软件直接使用,先解压;
2 软件同时支持32位64位运行环境;
3 如果软件无法正常打开,请右键使用管理员模式运行;