请选择 进入手机版 | 继续访问电脑版
  • 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

laravel-swagger: 初始化基于laravel5+swagger-php的api接口自动生成系统 ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

laravel-swagger

开源软件地址:

https://gitee.com/helei112g/laravel-swagger

开源软件介绍:

说明

该项目,主要用于解决API文档生成的问题。项目基于laravel5+swagger-php构成。项目源地址

改进日志

  • V1.1.1 修改了依赖swagger-php包版本问题(swagger-php v2上的版本使用了PSR-4标准)
  • 2015年7月1日 [v1.1.0] 修改路由
  • 修改了项目文件结构
  • 将swagger前端部分版本提升到V2.1版本,使用swagger前端项目地址
  • 将项目改进为PSR-4自动加载,抛弃之前的PSR-0

安装

建议采用 composer 进行安装,

  1. 在项目的composer.json中配置 "riverslei/laravel-swagger": "~1.0"
  2. 运行 composer update
  3. 安装完成后,配置 config/app.php 中的服务提供者 Riverslei\Swaggervel\SwaggervelServiceProvider::class
  4. 以上配置完成后,运行 php artisan vendor:publish ,生成相关的配置文件以及资源文件。

通过以上配置,已经完成了所有的安装工作,现在开始运行

运行

查看api-doc的路由,使用一下命令

php artisan route:list

根据路由信息,访问:baseUrl+api-docs,如果看到swagger的首页,说明已经成功

补充

安装该lib后,不需要再运行命令生成相关的json文件,一切在你运行url访问你项目swagger文档首页时,它会自动扫描相关的Model及Controller,一切就是这么美妙,以后再也不需要劳心费神的写api接口文档了。

这里给出swagger-php注解的书写规则文档:官方文档


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

热门推荐
阅读排行榜
  • ** REJECT ** DO NOT USE THIS CANDIDATE NUMBER. ConsultIDs: none. Reason: This ca

    阅读:347|2022-09-23
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:249|2022-09-18
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:264|2022-09-18
  • Novel-Plus v3.6.2 was discovered to contain a hard-coded JWT key located in the

    阅读:267|2022-09-18
  • Novel-Plus v3.6.2 was discovered to contain an arbitrary file download vulnerabi

    阅读:270|2022-09-18
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:188|2022-09-18
  • An issue was discovered in the Arm Mali GPU Kernel Driver. A non-privileged user

    阅读:300|2022-09-18
  • HashiCorp Boundary up to 0.10.1 did not properly perform data integrity checks t

    阅读:218|2022-09-18
  • In D-Link DIR-816 A2_v1.10CNB04.img a command injection vulnerability occurs in

    阅读:259|2022-09-18
  • D-Link DIR-816 A2_v1.10CNB04.img is vulnerable to Command Injection via /goform/

    阅读:219|2022-09-18

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap