如何在ThinkPHP6中使用Swagger

swagger是一种流行的api文档生成工具，可以帮助开发人员轻松地创建、设计和部署api接口。在本文中，我们将介绍如何在thinkphp6中使用swagger来生成api文档，并使用swagger-ui来查看和测试api接口。

第一步：安装Swagger-UI和Swagger-Annotations

要在ThinkPHP6中使用Swagger，需要安装Swagger-UI和Swagger-Annotations两个库。可以通过Composer来安装它们，只需在项目根目录下运行以下命令：

composer require zircote/swagger-php
composer require swagger-api/swagger-ui

第二步：在控制器中添加Swagger-Annotations

要在控制器中使用Swagger，需要在控制器的注释中添加Swagger-Annotations。例如，以下是一个示例控制器和其中使用Swagger-Annotations的示例代码：

<?php namespace appcontroller;
use thinknnotationouteGroup;
use thinknnotationouteMiddleware;
use thinkController;
/**
* @Group("/api/v1")
* @Middleware(class="ppmiddlewareToken")
*/
class UserController extends Controller
{
/**
* 用户列表接口
*
* @SwaggerGet(
*     path="/user/list",
*     summary="获取用户列表",
*     tags={"User"},
*     @SwaggerResponse(response="200", description="OK"),
*     @SwaggerResponse(response="401", description="Unauthorized"),
* )
*/
public function index()
{
// 代码逻辑
}
}

在上面的代码中，我们使用了@Group注释来指定控制器的路由前缀，使用@Middleware注释来指定控制器中间件。而在index方法中，我们使用了@SwaggerGet注释来指定GET请求所需的信息，如请求路径、接口摘要、标签和响应信息等等。

第三步：生成Swagger文档

生成Swagger文档的方法有很多种，包括手动编写Swagger文档、使用Swagger编辑器、使用Swagger生成器等等。在这里，我们将使用Swagger-Annotations提供的命令行工具来自动生成Swagger文档。

在项目根目录下输入以下命令：

php think swagger output json > swagger.json

这将使用Swagger-Annotations中的output命令将Swagger文档输出到JSON文件中。

第四步：使用Swagger-UI查看和测试API接口

现在，我们已经生成了Swagger文档，我们需要将它展示出来。我们可以使用Swagger-UI来查看和测试API接口。

在项目中新建一个目录public/swagger，将从Swagger-UI官网上下载的所有静态文件都复制到这个目录中。然后，我们需要修改index.html文件中的url变量，将其指向我们刚才生成的Swagger文档。

var url = "../swagger.json";

最后，在浏览器中打开http://localhost/swagger即可看到Swagger-UI界面。在这里，您可以浏览API接口文档，测试API接口，并查看API接口的请求和响应信息。

总结：

原文来自：www.php.cn