河流的/laravel-swagger

在 Laravel5 中使用 Swagger 自动生成 API 接口文档

维护者

详细信息

github.com/helei112g/laravel-swagger

源代码

问题

安装次数: 789

依赖者: 0

建议者: 0

安全性: 0

星级: 59

关注者: 8

分支: 24

开放问题: 0

语言:JavaScript

v1.1.1 2015-07-07 10:25 UTC

Requires

MIT a17bcbc980abdc6906b883130bed8c7cee882c19

  • helei112g <helei5200.woop@126.com>

documentationapilaravelswaggerSwagger-PHPlaravel5laravel swagger

This package is auto-updated.

Last update: 2024-08-29 04:31:01 UTC

README

该项目主要用于解决 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 的首页，说明已经成功

补充

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

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