• tp6 + swagger 配置文档接口

    ThinkPHP 6.0

    运行环境要求PHP7.2+，兼容PHP8.1

    安装

    composer create-project topthink/think tp 6.0.*

    • 1

    如果需要更新框架使用

    composer update topthink/framework

    • 1

    文档

    完全开发手册

    swagger

    文档

    注解文档

    安装包

    composer require zircote/swagger-php

    引用swagger-ui

    下载ui

    git clone https://github.com/swagger-api/swagger-ui.git

    下载到public下,后续访问要使用到。

    可以重命名，比如apidoc。

    修改swagger-ui/dist/index.html

    window.onload = function() {
  window.ui = SwaggerUIBundle({
    url: "/localhost:8000/swagger.json",
    dom_id: '#swagger-ui',
    deepLinking: true,
    presets: [
      SwaggerUIBundle.presets.apis,
      SwaggerUIStandalonePreset
    ],
    plugins: [
      SwaggerUIBundle.plugins.DownloadUrl
    ],
    layout: "StandaloneLayout"
  });
};

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    生成swagger.json
    第一种方式，手动命令行生成

    ./vendor/bin/openapi ./app/controller -o ./public/swagger.json

    第二种方式，调用方法

    建立路由

    route/app.php

    Route::group("index", function () {
    Route::rule('doc/[:isToJson]', 'doc');
    Route::rule('hello/[:name]', 'hello');
    Route::rule('index', 'index');
});

    • 1
    • 2
    • 3
    • 4
    • 5

    控制器
    app/controller/Index.php

    注释文档示例

    
namespace app\controller;

use app\BaseController;
use OpenApi\Annotations as OA;
use think\facade\View;

/**
 * @OA\Info(title="My First API", version="0.1")
 */
class Index extends BaseController
{
    /**
     * @OA\Get(
     *     path="/index/index",
     *     tags={"index"},
     *     summary="接口名称",
     *     description="接口描述",
     *     @OA\Response(response="200", description="An example resource")
     * )
     */
    public function index()
    {
       return view("index");
    }

    /**
     * @OA\Get(
     *     path="/index/hello/:name",
     *     tags={"index"},
     *     summary="输出hello+谁",
     *     @OA\Parameter(
     *         in="query",
     *         required=true,
     *         name="name",
     *         @OA\Schema(type="string"),
     *         description="名称"
     *     ),
     *     @OA\Response(response="200", description="An example resource")
     * )
     */
    public function hello($name = 'ThinkPHP6')
    {
        return 'hello,' . $name;
    }
    
    public function doc(bool $isToJson = false)
    {
        $openapi = \OpenApi\Generator::scan(['../app/controller']);
        header('Content-Type: application/x-json');
        if($isToJson) {
            return $openapi->toJson();
        }

        $res = file_put_contents('../public/swagger.json', $openapi->toJson());
        if ($res !== false) {
//            return redirect("localhost:${port}/docapi/index.html?port=${port}&docapi=${docapi}");
            return view();
        }
        return '没有文档';
    }

    // 空控制器
    public function __call($method, $args) {
        return 'error request';
    }
}


    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68

    配置模板全局变量
    config/view.php 最后加上

    'tpl_replace_string' => [
        '__SWAGGER__' => '/swagger-ui/dist/'
    ]

    • 1
    • 2
    • 3

    __SWAGGER__在下面的doc.html里面使用到

    视图
    view/index/doc.html

    DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <meta
            name="description"
            content="SwaggerUI"
    />
    <title>SwaggerUItitle>
    <link rel="stylesheet" type="text/css" href="__SWAGGER__/swagger-ui.css" />
    <link rel="stylesheet" type="text/css" href="__SWAGGER__/index.css" />
head>
<body>
<div id="swagger-ui">div>
<script src="__SWAGGER__/swagger-ui-bundle.js" charset="UTF-8"> script>
<script src="__SWAGGER__/swagger-ui-standalone-preset.js" charset="UTF-8"> script>
<script src="__SWAGGER__/swagger-initializer.js" charset="UTF-8"> script>
<script>
    window.onload = () => {
        window.ui = SwaggerUIBundle({
            url: location.origin + '/swagger.json',
            dom_id: '#swagger-ui',
            deepLinking: true,
            presets: [
                SwaggerUIBundle.presets.apis,
                SwaggerUIStandalonePreset
            ],
            plugins: [
                SwaggerUIBundle.plugins.DownloadUrl
            ],
            layout: "StandaloneLayout"
        });
    };
script>
body>
html>

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37

    在这里插入图片描述

  • 相关阅读:
    SQL note2：DIsks and Files
    二维码制作教程分享，大家一起来学习吧！
    MM32F0140 UART1中断接收和UART1中断发送
    Python逐日填补Excel中的日期并用0值填充缺失日期的数据
    建立一种特殊的字典访问不存在的键k时可以自动创建键k同时给k赋初值defaultdict()
    探索C嘎嘎的奇妙世界:第二关---C++的输入与输出
    深入理解锁
    9月1日，每日信息差
    Hi3559av100 u-boot bootargs bootcmd
    ImageReward：文本到图像生成中的人类偏好学习
  • 原文地址：https://blog.csdn.net/junjiahuang/article/details/133319228