接口文档神器---Swagger的简介

Swagger的简介

Swagger介绍

• 一款RESTFUL接口的文档在线生成软件
• 一款RESTFUL接口的功能测试软件
• 一座前后端开发者沟通的桥梁

Swagger解决的问题

• 解决后端开发者WIKI的维护问题
• 解决前端和后端开发者沟通问题
• 提高测试开发者的效率问题

OpenApi

• OpenApi简称OAS(OpenApi描述规范)
• 制定通用的与语言无关的REST API 描述规范
• 便于人类和计算机理解和使用服务的功能

Swagger

• 围绕OAS构建RESTful文档
• 动态生成接口定义文档
• 易用免费且开源

Swagger工具介绍

• Swagger Editor - 开源编辑器（类似markdown,可以在线编辑）
• Swagger UI - 呈现可交互在线文档
• Swagger Codegen - 生成调用代码的工具

Swagger用处

• 支持页面展示接口定义，节省专门编写接口文档的时间
• 基于代码生成文档，规避接口文档老旧问题
• 支持接口调试，降低开发阶段调试成本

Swagger跨语言

• 支持go和php语言的go-swagger和swagger-php
• 支持java语言的springfox
• 支持js和node语言的swagger-node和swagger-js