ThinkPHP中SwaggerV3擴(kuò)展包有什么用

小編給大家分享一下ThinkPHP中SwaggerV3擴(kuò)展包有什么用，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

源碼：https://github.com/liaoshengping/think-swagger

安裝：

composer require liaosp/think-swagger -vvv

創(chuàng)建包

我在tp的根目錄下創(chuàng)建pkg

mkdir pkg
cd pkgpackage-builder build think-swagger

添加 zircote/swagger-php，在composer.json  添加

添加swagger

    "require": {
        "zircote/swagger-php": "^3.2"
    },

根據(jù)  官網(wǎng)的示例，我們希望在TP觸發(fā)如下代碼

<?php
require("vendor/autoload.php");
$openapi = \OpenApi\Generator::scan(['/path/to/project']);
header('Content-Type: application/x-yaml');
echo $openapi->toYaml();

本地導(dǎo)入composer

需要在tp的compsoer 加入 “minimum-stability”: “dev”

 "minimum-stability": "dev"

repositories 加入

        {
            "type": "path",
            "url": "pkg\\think-swagger"
        }

創(chuàng)建控制器

在src 創(chuàng)建 一個Controller.php

一個是展示 html 的，一個是提供swagger api 接口的

具體代碼可查閱：

https://github.com/liaoshengping/think-swagger/blob/master/src/Controller.php

添加路由

    "autoload": {
        "psr-4": {
            "Liaosp\\ThinkSwagger\\": "src"
        },
        "files": [
            "src/route.php"
        ]
    },

添加router.php

tp5 我現(xiàn)在的版本可以這樣做，但是TP6我試了下，不行啊報錯；如果后面有Tp6項(xiàng)目了，我會把tp6部分整合一下歡迎大家收藏。

Route::any('apidoc', '\\Liaosp\\ThinkSwagger\\Controller@apidoc');
Route::any('apidocJson', '\\Liaosp\\ThinkSwagger\\Controller@apidocJson');

添加Swagger-ui

swagger ui 是 開源的 js庫  github.com/swagger-api/swagger-ui

靜態(tài)形式引用 dist/index.html

靜態(tài)資源導(dǎo)入

Swagger 主要需要這三個文件

            '/swagger/swagger-ui.css',
            '/swagger/swagger-ui-bundle.js',
            '/swagger/swagger-ui-standalone-preset.js'

tp5沒有publish ，所以我想了一個辦法，通過查詢是否存在資源，進(jìn)行資源的發(fā)布。感興趣的可以看下上面提供的源碼

一些感想

可能我的思維Laravel化了，在開發(fā)之前我認(rèn)為一些 本應(yīng)該有的擴(kuò)展功能都應(yīng)該有的，但是我查閱了好幾個作者的think-swagger擴(kuò)展包，不太靈活了。以至于有一些開發(fā)擴(kuò)展包的同學(xué)，需要手動改源碼，或者干脆就沒有composer 包，直接寫教程如何去實(shí)現(xiàn)。

接著我查閱了下Tp6的源碼，在開發(fā)擴(kuò)展方面有一定的增強(qiáng)，比如下面的是我學(xué)Tp6 的官方的插件：

Laravel 的包的提供者的命名官方的是在包名加 Provider

我查閱了下tp的擴(kuò)展包，習(xí)慣于用Service 作為包的提供者    "extra": {
        "think": {
            "services": [
                "Liaosp\\ThinkSwagger\\Service"
            ]
        }
    }

不過Laravel 之前也需要手動添加Provider，希望國產(chǎn)Tp越來越好，目前我測試了下這個包可以在Tp5運(yùn)行，tp6不行。后面再看看有沒有接觸TP6項(xiàng)目再把這個包升級一下吧。

以上是“ThinkPHP中SwaggerV3擴(kuò)展包有什么用”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對大家有所幫助，如果還想學(xué)習(xí)更多知識，歡迎關(guān)注億速云行業(yè)資訊頻道！