Swagger Editor(API开发工具) v2.0.1

Swagger Editor(API开发工具)是一款非常强大的编程开发软件，这款软件的工具很多，使用起来也非常的方便，且软件运行占用低，运行的速度也非常的便捷安全。

Swagger Editor(API开发工具)功能特点：

运行在任何环境

编辑器在任何开发环境中工作，无论是在本地还是在Web上。

智能反馈

在编写简洁的反馈和错误处理时，验证OAS遵从性的语法

即时可视化

可视化地呈现API规范并与API交互，同时定义它

智能自动完成

用智能和智能自动完成更快地编写语法

完全可定制

易于配置和定制任何东西，从线间距到主题

关于你的开发

在每个流行语言中为API生成服务器存根和客户端库

Swagger Editor(API开发工具)介绍：

什么是API

API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数

目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力

而又无需访问源码，或理解内部工作机制的细节。

Swagger Editor(API开发工具)搭建：

1.下载Swagger UI（也可以直接下载 zip 文件）

git clone https://github.com/swagger-api/swagger-ui.git

2.安装 express

3.创建一个空文件夹node_app

mkdir node_app

4.初始化 node ，创建package.json文件（）

➜ ~ ✗ >cd node_ap

➜ ~/node_app ✗ >npm init

// 下面的看你心情填写

name: (node_app) node_app

version: (1.0.0)

description:

entry point: (index.js)

test command:

git repository:

keywords:

author:

license: (ISC)

4.安装 express

➜ ~/node_app git:(master) ✗ >npm install express --save

5.创建 index.js

➜ ~/node_app git:(master) ✗ >vim index.js

6.把下面代码贴如 index.js 中

var express = require('express');

var app = express();

app.get('/', function (req, res) {

res.send('Hello World!');

});

app.listen(3000, function () {

console.log('Example app listening on port 3000!');

});

7.在 node_app 中创建空目录 public

➜ ~/node_app git:(master) ✗ >mkdir public

➜ ~/node_app git:(master) ✗ >cd public

8.修改路由

➜ ~/node_app/public git:(master) ✗ >vim ../index.js

//在文件第三行插入下面这句话

app.use('/static', express.static('public'));

9.把下载好的Swagger UI 文件中dist 目录下的文件全部复制到 public 文件夹下。

10.开启 node

➜ ~/node_app git:(master) ✗ >node index.js

11.打开浏览器，输入

到此为止，你已经把官方的 demo 在本地配置好了。当然你也可以吧这个搭建在服务器上

Swagger Editor(API开发工具)设置：

Swagger Editor界面分为导航栏和工作区。导航栏是对接口文档的处理用，工作区就是我们花时间最多的地方。

分为左右区域，左边是编辑区，右边是显示区。

左边编辑区使用的YAML语法来编写，只要一修改右边显示区立刻有变化，使用很便捷。

进入swagger edit会默认填入一个demo文档，通常我们只需要修改demo文档，就能制作我们想要的接口文档。

编写完文档点击展示区的excute，进行测试接口。

File

这个用来导出/引入接口文件在swagger edit里面进行编辑，也可以输出YAML/JSON格式。这个如果你是非在线版，编辑一半想下次在编辑，建议先导出备份，避免数据丢失。

convert to YAML

把编辑区转换成YAML格式。

Generate Server

把接口文档生成服务器文件，导出一个压缩包，接口文档生成java、js等服务器文件。很实用工具，让你写少很多代码。

导出spring-boot

导出nodeJS

Generate Client

生成查看接口文档。编写好下一步就是展示。这里可以选择导出什么格式的接口文档。