Swagger的基础入门
- Swagger包括Swagger Editor， Swagger UI等很多部分，这里我们主要讲一下Swagger Editor。它是一个完全开源的项目，并且它也是一个基于Angular的成功案例。
- 在Swagger Editor中，我们可以基于YAML等语法定义我们的RESTful API，然后它会自动生成一篇排版优美的API文档，并且提供实时预览。简单说就是可以边编写API 边预览边测试。
- 在Swagger UI中，我们不能进行编写API ，但是我们可以预览或者测试。
安装Swagger editor
Node.js 安装
node中 http-server安装
npm install http-server
下载swagger-editor
- 从官网下载swagger-editor.zip，解压即可。 https://swagger.io/
启动swagger-editor
- http-server E:\swagger-editor-master\swagger-editor-master
- 当出现以下提示，则证明成功了。
使用浏览器访问
http://127.0.0.1:8081
界面左边是api 文件的 yaml 描述文件， 左边部分可以直接编辑API文档，编辑会立即更新到右边视图。右边是swagger-UI，可以查看文档，并直接进行API的测试。
安装 Swagger UI
下载swagger-ui
- 从官网下载swagger-ui
git clone https://github.com/swagger-api/swagger-ui.git
创建一个空文件夹
mkdir node_app
初始化node，创建package.json
➜ ~ ✗ >cd node_app
➜ ~/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)
安装express
npm initnpm install express --save
创建index.js
vim index.js
将代码贴在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!');
});
在 node_app 中创建空目录 public
修改路由
- 在文件第三行插入下面这句话
app.use('/static', express.static('public'));
把下载好的Swagger UI 文件中dist 目录下的文件全部复制到 public 文件夹下
开启node
node index.js
访问
- ``
