Swagger Editor 快速入门

简介

Swagger 是最受欢迎的REST APIs文档生成工具之一

Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。

Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。

Swagger 文件可以在许多不同的平台上如node,java从代码注释中自动生成。

功能

后端负责在线编辑接口文档,在线可以生成IOS,Android客户端网络层代码,省去编码时间。如图:


Swagger Editor 快速入门

下面学习Swagger Editor如何编辑

主要分三个部分,第一是版本和协议定义,第二定义接口,第三定义实体Bean

Swagger Editor 快速入门

接口定义

第一部分看上图理解,下面直接看第二部分,分别以get,post,put,delete为例

get栗子

Swagger Editor 快速入门
栗子

post栗子

Swagger Editor 快速入门
栗子

put栗子

Swagger Editor 快速入门
栗子

delete栗子

Swagger Editor 快速入门
栗子

实体部分

Swagger Editor 快速入门
栗子

其他部分参考