SwaggerEditor是一款非常实用的api开发设计工具,通过此软件可以利用这款软件生成API文档,允许您在浏览器中编辑YAML中的[SwaggerAPI规范并实时预览文档,然后可以生成有效的SwaggerJSON描述并与完整的Swagger工具一起使用,大大提高了开发人员的工作效率,可以让你用YAML来定义你的接口规范,并实时验证和现实成接口文档。
软件特色
Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。
Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
Swagger 有一个强大的社区,里面有许多强悍的贡献者。
功能介绍
1.运行在任何环境
编辑器在任何开发环境中工作,无论是在本地还是在Web上。
2.智能反馈
在编写简洁的反馈和错误处理时,验证OAS遵从性的语法。
3.即时可视化
可视化地呈现API规范并与API交互,同时定义它。
4.智能自动完成
用智能和智能自动完成更快地编写语法。
5.完全可定制
易于配置和定制任何东西,从线间距到主题。
6.关于你的开发
在每个流行语言中为API生成服务器存根和客户端库。
使用方法
1.展开 pet 的 post 方法;
2.然后单击 Model Schema 中的黄色字体的 JSON。
3.这里用 JSON 填充了 body value。这里的 JSON 是你必须上传的,用于创建 pet 资源。
4.将第一个 id 标签的值修改一下(你必须保证 id 值都是唯一的,并且不能从 0 开始)。
5.将 name 标签的值修改一下(最好也要唯一,方便对比结果),以下是示例代码:
6.单击 Try it out! 按钮,查看响应:
更新日志
您的代码引入了哪些类型的更改?在所有适用的框中放置一个`x`: - >
没有代码更改(`src /`未修改:对文档,CI,元数据等的更改)
依赖项更改(对`package.json`中依赖项的任何修改)
错误修复(修复问题的非破坏性修改)
改进(错误更改现有功能)
功能(增加功能的非破坏性更改)
正在对公共API(配置选项,系统API,主要UI更改等)进行更改。
正在改变私有API(Redux,组件道具,实用程序功能等)。
正在破坏对开发人员API的更改(npm脚本行为更改,新开发系统依赖关系等)。
我的更改不能或不需要测试。
我的更改可以并且应该通过单元和/或集成测试进行测试。
如果是以上:我已添加测试以涵盖我的更改。
如果是以上:我已经注意在我的测试中覆盖边缘情况。
所有新的和现有的测试都通过了。