编写Swagger用于开发API文档

Swagger在API文档编写中的应用

• 1 Swagger
  • • 1.1 Swagger的定义
    • 1.2 关于SwaggerEditor的安装及运行方法
    • 1.3 示例代码的编写过程
    • 1.4 SwaggerUI的配置与部署

1 Swagger

1.1 什么是Swagger

在互联网技术不断进步的背景下，当前网站架构已由传统的后端渲染模式演变为前端渲染与前后端分离的结构，同时前端与后端技术在各自的发展路径上逐渐独立。
前端与后端之间唯一的连接方式，转变为API接口；API文档则成为前后端开发人员沟通的重要桥梁，其重要性日益凸显，swagger便是一款能够有效提升API文档编写的框架。

1.2 SwaggerEditor安装与启动

1）全局部署http-server
http-server是一款无需复杂配置的命令行工具，可快速搭建HTTP服务器
通过执行命令npm install ‐g http‐server完成全局安装
2）运行swagger-editor
首先在命令提示符中切换至swagger-editor所在目录
随后输入指令http‐server swagger‐editor以启动服务
接着在浏览器中访问： http://localhost: