swagger-editor入门指南

一.Swagger&&Swager-editor简介

随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。

前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，而swagger就是一款让你更好的书写API文档的框架.是当前最受欢迎的REST API文档生成工具之一。

总而言之,swagger就是一款功能强大的适合于采用前后端分离的架构项目的API文档设计工具。

Swagger Editor是Swagger中的编辑器，并且它也是一个基于Angular的成功案例。在Swagger Editor中，我们可以基于YAML等语法定义我们的RESTful API，然后它会自动生成一篇排版优美的API文档，并且提供实时预览。简单说就是可以边编写API 边预览边测试。

Swagger官方提供了一个Swagger Editor的在线的web版本，http://editor.swagger.io/#/， 当然我们也可以下载到自己的机器在本地运行,下面说说在本地如何运行。

二.Swagger Editor安装与启动

（1）到官网下载 https://swagger.io/download-page/ 。

（2）解压swagger-editor-master,

（3）安装

npm install 

（4）启动swagger-editor

npm start

（5）浏览器打开： http://localhost:3001/#

（6）打开会有swager提供的demo,可对照接下来的Swagger语法规则进行学习

三.Swagger语法规则

3.1字段类型与格式定义

3.2固定字段

注:swagger字段很多,要全部记下来需要花费大量的时间,笔者整理出来的了比较常用的固定字段,可以主要记忆,其他的固定字段,先了解即可,关键固定字段如下: