swaggerUIswagger-php使用

Swagger 是⼀个规范和完整的框架，⽤于⽣成、描述、调⽤和可视化 RESTful 风格的 Web 服务。更好的实现前后端分离。⼀ .Swagger UI 搭配node使⽤。 1.下载 Swagger UI　　

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

2. 安装express 并创建⼀个⽂件夹node-app.。初始化node。

cd node-appnpm init

3. 安装express

npm install express --save

4. 创建空⽬录 public 5. 创建index.js 并输⼊代码

var express = require('express');var app = express();

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

app.get('/', function (req, res) { res.send('Hello World!'); }); app.listen(3000, function () { console.log('Example app listening on port 3000!'); });

6.把下载好的Swagger UI ⽂件中dist ⽬录下的⽂件全部复制到 public ⽂件夹下。7.开启服务

node index.js

8.打开浏览器查看⽂档

⼆、SwaggerEditor 编写Api⽂档。在线编辑 ，⽣成对应的json⽂档。三、swagger-php ⾃动⽣成json⽂件。1. 下载 swagger-php

git clone https://github.com/zircote/swagger-php.git

2.安装 composer

curl -sS https://getcomposer.org/installer | php （Mac下）

mv composer.phar /usr/local/bin/composer （所以最佳做法是将它放到 usr/local/bin ⽬录中中，成为全域指令。）

3.更新项⽬

composer update

4.编写⽂档，可以参考 examples下的例⼦。5. ⽣成json⽂件。

bin/swagger examples -o swagger-docs

6.将⽣成的json⽂件 复制到 1 中的public⽂件夹下。

这样就能查看使⽤ api⽂档了。