Laravel开发：怎样使用Laravel Swagger天生API文档 ？
laravel开发：怎样使用laravel swagger天生api文档 ？
在开发 Web 应用程序时 ，处理 API 文档往往是一项繁琐但必不可少的使命。使用 Swagger 可以自动天生 API 文档并使其可视化。在 Laravel 开发中 ，我们可以使用 Laravel Swagger 扩展包来轻松地天生 Swagger API 文档。本文将指引您怎样在 Laravel 中使用 Laravel Swagger。
装置 Laravel Swagger
使用 Composer 装置 Laravel Swagger 扩展包：
composer require darkaonline/l5-swagger
登录后复制
设置 Laravel Swagger
Laravel Swagger 依赖于 Swagger UI ，因此我们需要将 Swagger UI 的资源宣布到 Laravel 的公共目录中 ，使用以下下令完成宣布：
php artisan vendor:publish --provider "L5SwaggerL5SwaggerServiceProvider"
登录后复制
执行宣布下令后 ，将会在 public/vendor 目录下看到 swagger-ui 目录 ，这个目录中包括了 Swagger UI 的所有资源。
接下来 ，在 Laravel 的设置文件 config/app.php 中添加以下行：
'providers' => [
...
L5SwaggerL5SwaggerServiceProvider::class,
],
'aliases' => [
...
'Swagger' => L5SwaggerFacadesL5Swagger::class,
],
登录后复制
添加 Swagger 注释
为了告诉 Laravel Swagger 没有推断的 API 名堂 ，我们需要在代码中添加 Swagger 注释。这些注释可以让 Laravel Swagger 自动剖析您的 API ，并天生对应的文档。
/**
* @OAGet(
* path="/users",
* operationId="getUsersList",
* tags={"Users"},
* summary="Get list of registered users",
* description="Returns list of users",
* @OAResponse(response="200", description="successful operation"),
* @OAResponse(response=401, description="Unauthorized"),
* @OAResponse(response=403, description="Forbidden"),
* @OAResponse(response=404, description="Not Found"),
* @OAResponse(response=500, description="Internal Server Error")
* )
*/
登录后复制
在上面的示例中 ，我们使用 @OAGet 注释体现这是一个 GET 请求。path 注释界说 API 的路径。tags 和 summary 注释用于在 Swagger 文档中显示摘要和标签。最后 ，@OAResponse 注释示例了可能的响应状态。
在 Laravel 中审查 Swagger 文档
在完成所有先前的办法之后 ，我们可以使用以下 URL 来审查 Laravel Swagger 文档：
http://your-app.dev/api/documentation
登录后复制
（请注重 ，若是您使用的是 Laravel 5.4 或以上版本 ，则无需界说 .dev ，请改为使用 .test 或其他外地区名）
启动 Laravel 的开发效劳器 ，并会见上面的 URL ，您应该能够在浏览器中看到自动天生的 Swagger 文档。
在 Swagger 文档中 ，您可以审查界说的 API ，凭证 API 中添加的 Swagger 注释来测试 API ，并审查可能的响应状态。
总结
在本文中 ，我们相识了怎样使用 Laravel Swagger 扩展包轻松天生 Swagger API 文档。首先 ，我们装置了 Laravel Swagger ，然后启动 Swagger ，并为 API 添加了 Swagger 注释。最后 ，我们审查了 Laravel Swagger 天生的文档。
使用 Laravel Swagger 可以大大减轻手动编写 API 文档的肩负 ，阻止了可能的过失和纷歧致性。通过使用 Swagger UI ，我们可以更利便地审查和测试 API ，同时提供了对开发职员友好的接口。
以上就是Laravel开发：怎样使用Laravel Swagger天生API文档 ？的详细内容 ，更多请关注本网内其它相关文章！
