码迷,mamicode.com
首页 > Web开发 > 详细

swaggerUI swagger-php 使用

时间:2017-10-20 16:49:43      阅读:561      评论:0      收藏:0      [点我收藏+]

标签:目录   使用   composer   edit   index   github   php   输入   var   

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-app
npm 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文档。

    基于yaml语法。官网:https://swagger.io/swagger-editor/

在线编辑 ,生成对应的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文档了。

参考:https://github.com/swagger-api/swagger-ui 

     https://swagger.io/swagger-editor/

 

 

swaggerUI swagger-php 使用

标签:目录   使用   composer   edit   index   github   php   输入   var   

原文地址:http://www.cnblogs.com/yxcoding/p/7699998.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!