安装和配置
- composer require "darkaonline/l5-swagger" //目前是最新的
- php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
- php artisan l5-swagger:generate
访问
- http://127.0.0.1/api/documentation //但是会报错
- 在storage下创建一个api-docs.json文件
在控制器中创建文件
//可以指定server和端口 如果不写默认本机
/**
* @OA\Info(
* title="Auth api",
* version="0.0.1"
* )
* @OA\Server(
* url="http://xx.xxx.xx.xxx:xxx"
* ),
*/
class LoginController extends Controller{
/**
* @OA\Get(
* path="/projects",
* @OA\Response(response="200", description="Display a listing of projects.")
* )
*/
public function test()
{
return 'test -> user';
}
}
执行 php artisan l5-swagger:generate
- 再次访问 http://127.0.0.1/api/documentation,问题解决
参考1:在laravel中集成swagger_小小郭-CSDN博客
参考2:无法在 l5-swagger 中生成 API 文档 - 堆栈内存溢出
参考3:darkaonline/l5-swagger - Packagist
github地址:GitHub - DarkaOnLine/L5-Swagger: OpenApi or Swagger integration to Laravel
学习资源#
- swagger-php guide
- swagger-php 里面有例子,但是我发现好像不是很全
- Swagger Editor
- swagger 文档