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