博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
swagger系列一:laravel中部署swagger ui
阅读量:6360 次
发布时间:2019-06-23

本文共 797 字,大约阅读时间需要 2 分钟。

1. 部署swagger ui 到项目中:

可以Git下来 git clone https://github.com/swagger-api/swagger-uiv

也可以下载zip文件。解压后把目录下的dist目录拷贝到 laravel下public下的文件夹中,如新建docs。访问http://localhost/docs/

图片描述

2. 修改为自己的项目文件。

打开docs(即dist下index.html)下index.html。找到url: "http://petstore.swagger.io/v2/swagger.json",,把URL修改为自己的,如url: "swagger.json",,再次访问即可。但是swagger.json并不存在,需要生成。

3. swagger-php从代码和现有的phpdoc注释中提取信息,为您的RESTful API 生成交互式Swagger文档。与Swagger 2.0规范兼容。

在Laravel项目中安装swagger-php:

$ composer require zircote/swagger-php
也可以指定版本安装 : composer require zircote/swagger-php 2.0.13 指定的2.0.13版本

4. 安装完成后,可以用swagger-php测试示例测试。

如:放在public下的docs目录,用于存放swagger.json文件。执行命令:

$php vendor/zircote/swagger-php/bin/swagger vendor/zircote/swagger-php/Examples -o public/docs
再次访问即可。界面或许看起来和swagger ui的默认一样,是因为用的同样的模板,但是以后用自己的注释生成的swagger.json文件重新覆盖即可。

转载地址:http://pvbma.baihongyu.com/

你可能感兴趣的文章
Jersey+mybatis实现web项目第一篇
查看>>
C++形参中const char * 与 char * 的区别
查看>>
espresso 2.0.4 Apple Xcode 4.4.1 coteditor 价格
查看>>
Object-C中emoji与json的问题
查看>>
linux 命令
查看>>
灾后重建
查看>>
Nothing 和 Is
查看>>
第一个sprint冲刺第三天
查看>>
周末web前端练习
查看>>
hdu 5754 Life Winner Bo 博弈论
查看>>
Overlay network 覆盖网络
查看>>
Linux之编译需要的文件变化时刻
查看>>
IntelliJ IDEA中怎么查看方法说明?
查看>>
mvn常用命令
查看>>
redis zset 顺序问题
查看>>
C# 判断网站是不是discuz论坛
查看>>
Moving to Docker(二)搭建一个私有registry服务
查看>>
《SQL入门经典(第5版)》一一6.3 事务控制与数据库性能
查看>>
数据的IO和复用
查看>>
Windows远程连接CentOS桌面
查看>>