Swagger1

1.1 Swagger

swagger是干啥的？

简单但功能强大的api表达工具

1.2OpenAPI规范

是REST API的API描述格式。OpenAPI 规范帮助我们描述一个API的基本信息，比如：

• 有关该API的一般性描述（Info）
• 可用路径（/资源) (path)
• 在每个路径上的可用操作（获取/提交） (get/post)
• 每个操作的输入输出格式

目前OpenAPI规范已经发布并开源在github上。

1.3为啥要使用OpenAPI规范

更简单、快速的表述API

一旦编写完成可以作为程序员的guide使用

1.4如何编写API文档

用JSON或YAML,YAML更能简化书写和阅读

1.4.1编辑器

Swagger Editor

 

转载于:https://www.cnblogs.com/itmeatball/p/10533088.html