如何使用PHP和Swagger进行API文档生成-php教程-PHP中文网

如何使用PHP和Swagger进行API文档生成

王林

发布： 2023-05-11 16:40:42

原创

2318人浏览过

随着互联网的快速发展，api（application programming interface）已经成为现代应用程序开发的标准方式。api是指允许应用程序之间交换数据和功能的一组接口，使得应用程序之间可以方便、快捷地交互。

当我们创建了一个API后，为了方便其他开发者使用我们的API，需要为API编写详细的文档。然而，手动编写API文档是一项耗费时间和精力的工作，因此使用自动化工具进行API文档生成是非常必要和有效的。

本文将介绍如何使用PHP和Swagger进行API文档生成。

一、Swagger是什么？

Swagger是一种用于描述和定义RESTful APIs的规范。它可以被用于生成人类可读的文档，以及代码生成器，以生成客户端和服务端代码。Swagger还可以用于API测试和调试。

立即学习“PHP免费学习笔记（深入）”；

二、Swagger的安装与配置

要使用Swagger生成API文档，首先需要安装它。我们可以使用Composer来安装Swagger，Composer是PHP的一个依赖管理器，可以下载最新版本的Swagger。

使用以下命令进行Swagger的安装：

composer require "swagger-api/swagger-ui:^3.50"

登录后复制

安装完成后，我们需要为Swagger进行一些配置。在项目根目录下创建一个swagger.php文件，并添加以下代码：

<?php

require_once(__DIR__ . '/vendor/autoload.php');

use OpenApiAnnotations as OA;

$swagger = OpenApiscan('/path/to/your/controllers');

header('Content-Type: application/json');
echo $swagger;

登录后复制

在以上代码中，/path/to/your/controllers应被替换为你自己的控制器路径。此外，我们还需要在composer.json文件中添加一些配置：

    "config": {
        "platform": {
            "php": "7.4"
        }
    },
    "autoload": {
        "classmap": [
            "app/",
            "database/",
            "routes/",
            "tests/"
        ]
    },
    "require": {
        "php": "^7.4",
        "laravel/framework": "^8.40",
        "tymon/jwt-auth": "^1.0",
        "doctrine/dbal": "^2.13",
        "swagger-api/swagger-ui": "^3.50"
    },
    "require-dev": {
        "facade/ignition": "^2.5",
        "fzaninotto/faker": "^1.9.1",
        "mockery/mockery": "^1.4.2",
        "nunomaduro/collision": "^6.0",
        "phpunit/phpunit": "^9.3.3"
    },

登录后复制

三、使用Swagger生成API文档

Calliper 文档对比神器

文档内容对比神器

查看详情

安装和配置完Swagger后，我们就可以开始使用它来生成API文档了。我们可以使用以下命令来生成API文档：

php swagger.php > swagger.json

登录后复制

在以上命令中，swagger.php是刚才所创建的Swagger配置文件，swagger.json是我们生成的API文档文件。

四、使用Swagger UI展现API文档

生成API文档后，我们希望将其展现出来，以方便其他人查看。可以使用Swagger UI来展现API文档。Swagger UI是用于展示Swagger所描述的RESTful API信息及其实现的JavaScript库。

我们可以将以下内容添加到public目录下的index.php文件中：

require_once(__DIR__ . '/../vendor/autoload.php');

$swagger = file_get_contents(__DIR__ . '/../swagger.json');
$swaggerData = json_decode($swagger, true);
?>
  <!DOCTYPE html>
  <html>
  <head>
    <meta charset="UTF-8">
    <title>Swagger UI</title>
    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui.min.css" >
    <style>
      html
      {
        box-sizing: border-box;
        overflow: -moz-scrollbars-vertical;
        overflow-y: scroll;
      }
      *, *:before, *:after
      {
        box-sizing: inherit;
      }

      body
      {
        margin:0;
        background: #fafafa;
      }
    </style>
  </head>

  <body>
  <div id="swagger-ui"></div>

  <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-bundle.js"> </script>
  <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-standalone-preset.js"> </script>
  <script>
      window.onload = function() {
          // Begin Swagger UI call region
          const ui = SwaggerUIBundle({
            url: "<?php echo '/swagger.json'; ?>",
            dom_id: '#swagger-ui',
            deepLinking: true,
            presets: [
              SwaggerUIBundle.presets.apis,
              SwaggerUIStandalonePreset
            ],
            plugins: [
              SwaggerUIBundle.plugins.DownloadUrl
            ],
            layout: "StandaloneLayout"
          })
          // End Swagger UI call region
          
          window.ui = ui
      }
  </script>
  </body>

  </html>

登录后复制

在以上代码中，我们使用了Swagger UI的JavaScript库，通过该库可以将生成的API文档以美观的HTML页面形式展现出来。

展示API文档的示例页面如下图所示：

api-docs

五、结论

使用Swagger可以方便地对API进行文档生成和管理。本文介绍了使用PHP和Swagger进行API文档生成的方法，步骤包括安装和配置Swagger、使用Swagger生成API文档以及使用Swagger UI展现API文档。相信读者经过本文的介绍后，能够轻松地使用Swagger生成自己的API文档。

以上就是如何使用PHP和Swagger进行API文档生成的详细内容，更多请关注php中文网其它相关文章！