Swagger Editor是一款针对REST APIs文档的在线生成工具,可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。还可以生成客户端SDK代码用于各种不同的平台上的实现。
软件特色
Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。
Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
Swagger 有一个强大的社区,里面有许多强悍的贡献者。
软件功能
1.运行在任何环境
编辑器在任何开发环境中工作,无论是在本地还是在Web上。
2.智能反馈
在编写简洁的反馈和错误处理时,验证OAS遵从性的语法。
3.即时可视化
可视化地呈现API规范并与API交互,同时定义它。
4.智能自动完成
用智能和智能自动完成更快地编写语法。
5.完全可定制
易于配置和定制任何东西,从线间距到主题。
6.关于你的开发
在每个流行语言中为API生成服务器存根和客户端库。
界面介绍
主要分三个部分,第一是版本和协议定义,第二定义接口,第三定义实体Bean
接口定义
第一部分看上图理解,下面直接看第二部分,分别以get,post,put,delete为例
get
post
put
delete
实体部分
使用方法
1.展开 pet 的 post 方法;
2.然后单击 Model Schema 中的黄色字体的 JSON。
3.这里用 JSON 填充了 body value。这里的 JSON 是你必须上传的,用于创建 pet 资源。
4.将第一个 id 标签的值修改一下(你必须保证 id 值都是唯一的,并且不能从 0 开始)。
5.将 name 标签的值修改一下(最好也要唯一,方便对比结果),以下是示例代码:
6.单击 Try it out! 按钮,查看响应: