swagger系列一：laravel中部署swagger ui

lookSomeone 发布于2019-06-28 18:39 / 1237人阅读

摘要：部署到项目中可以下来也可以下载文件。解压后把目录下的目录拷贝到下下的文件夹中，如新建。访问修改为自己的项目文件。找到，把修改为自己的，如，再次访问即可。但是并不存在，需要生成。如放在下的目录，用于存放文件。

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文件重新覆盖即可。

专线服务私有云 swagger swagger+spring 轻量云服务器 swagger 云服务器jar包swagger

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/28501.html

Swagger PHP使用指南

摘要：，已经好了，试着访问根目录下，比如试试，出现界面就成功了没从先就用命令看下的路由最上面条就是刚刚添加的路由。先说什么是Swagger, Swagger的使用目的是方便优美的呈现出接口API的各种定义, 生成API文档, 包括参数, 路径之类. 有时后端改了API的参数或者其他设置, 前端直接看这个Swagger UI就可以, 方便项目管理和团队协作. 官网: http://swagg...

cnio 2019-07-01 10:26 评论0 收藏0
api 接口管理工具

摘要：接口管理工具大致分为线上工具和自建工具。安装其他工具上面讲的，不管是线上工具还是自建工具，都是接口集成工具，主要是为了提供数据功能。类似网易云笔记印象笔记的笔记管理工具。 api 接口管理工具现在，Web 应用的前后端分离事实上已经成为了大家都认可的一种开发方式，前后端分离之后，前端与后端都用接口（api）来沟通，这就需要我们做好 API 接口管理，所以，这次来聊聊 API 接口管理...

marser 2019-08-23 14:43 评论0 收藏0
api 接口管理工具

摘要：接口管理工具大致分为线上工具和自建工具。安装其他工具上面讲的，不管是线上工具还是自建工具，都是接口集成工具，主要是为了提供数据功能。类似网易云笔记印象笔记的笔记管理工具。 api 接口管理工具现在，Web 应用的前后端分离事实上已经成为了大家都认可的一种开发方式，前后端分离之后，前端与后端都用接口（api）来沟通，这就需要我们做好 API 接口管理，所以，这次来聊聊 API 接口管理...

wuyumin 2019-08-16 14:27 评论0 收藏0
laravel使用手札——使用PHPStorm提升开发速度

摘要：安装支持和请移步到使用手札。在安装支持菜单栏搜索和安装使用时可不用完全参照插件的备注方式，使用自动补全内容的格式便可以，即建设的备注格式在自动补全小结从官方文档能看出对于支持可选和，经过试验后发觉必须安装才能很好地使用备注补全功能。 PHPStorm安装 PHPStorm 使用手札——安装看这里代码自动提示支持 laravel引入laravel-ide-helper能为PHPStor...

caozhijian 2019-07-01 12:14 评论0 收藏0
【效率专精系列】善用API统一描述语言提升RestAPI开发效率

摘要：其标准为前身是，提供强大的在线编辑功能，包括语法高亮错误提示自动完成实时预览，并且支持用户以格式撰写导入导出转换文档。团队内部RestAPI开发采用设计驱动开发的模式，即使用API设计文档解耦前端和后端的开发过程，双方只在联调与测试时耦合。在实际开发和与前端合作的过程中，受限于众多因素的影响，开发效率还有进一步提高的空间。本文的目的是优化工具链支持，减少一部分重复和枯燥的劳动。现状...

tianyu 2019-08-16 10:42 评论0 收藏0