下面thinkphp框架教程欄目將給大家分享一個thinkphp swaggerv3擴展包,希望對需要的朋友有所幫助!
大致過程和我之前寫的Laravel 擴展差不多 ?Laravel 寫一個中文驗證擴展包只有一些小小的區別這邊寫個教程。希望為thinkphp 開發者做一點點貢獻。主要講一些開發的過程和一些感悟吧,對Tp不是特別熟,歡迎大家指正~
源碼:https://github.com/liaoshengping/think-swagger
安裝:
composer require liaosp/think-swagger -vvv
創建包
我在tp的根目錄下創建pkg
立即學習“PHP免費學習筆記(深入)”;
mkdir pkg cd pkgpackage-builder build think-swagger
添加 zircote/swagger-php,在composer.json ?添加
添加swagger
"require": { "zircote/swagger-php": "^3.2" },
根據 ?官網的示例,我們希望在TP觸發如下代碼
<?php require("vendor/autoload.php"); $openapi = OpenApiGenerator::scan(['/path/to/project']); header('Content-Type: application/x-yaml'); echo $openapi->toYaml();
本地導入composer
需要在tp的compsoer 加入 “minimum-stability”: “dev”
"minimum-stability": "dev"
repositories 加入
{ "type": "path", "url": "pkgthink-swagger" }
創建控制器
在src 創建 一個Controller.php
一個是展示 html 的,一個是提供swagger api 接口的
具體代碼可查閱:
https://github.com/liaoshengping/think-swagger/blob/master/src/Controller.php
添加路由
"autoload": { "psr-4": { "LiaospThinkSwagger": "src" }, "files": [ "src/route.php" ] },
添加router.php
tp5 我現在的版本可以這樣做,但是TP6我試了下,不行啊報錯;如果后面有Tp6項目了,我會把tp6部分整合一下歡迎大家收藏。
Route::any('apidoc', 'LiaospThinkSwaggerController@apidoc'); Route::any('apidocJson', 'LiaospThinkSwaggerController@apidocJson');
添加Swagger-ui
swagger ui 是 開源的 js庫 ?github.com/swagger-api/swagger-ui
靜態形式引用 dist/index.html
靜態資源導入
Swagger 主要需要這三個文件
'/swagger/swagger-ui.css', '/swagger/swagger-ui-bundle.js', '/swagger/swagger-ui-standalone-preset.js'
tp5沒有publish ,所以我想了一個辦法,通過查詢是否存在資源,進行資源的發布。感興趣的可以看下上面提供的源碼
一些感想
可能我的思維Laravel化了,在開發之前我認為一些 本應該有的擴展功能都應該有的,但是我查閱了好幾個作者的think-swagger擴展包,不太靈活了。以至于有一些開發擴展包的同學,需要手動改源碼,或者干脆就沒有composer 包,直接寫教程如何去實現。
接著我查閱了下Tp6的源碼,在開發擴展方面有一定的增強,比如下面的是我學Tp6 的官方的插件:
Laravel 的包的提供者的命名官方的是在包名加 Provider 我查閱了下tp的擴展包,習慣于用Service 作為包的提供者 "extra": { "think": { "services": [ "LiaospThinkSwaggerService" ] } }
不過Laravel 之前也需要手動添加Provider,希望國產Tp越來越好,目前我測試了下這個包可以在Tp5運行,tp6不行。后面再看看有沒有接觸TP6項目再把這個包升級一下吧。
源碼:https://github.com/liaoshengping/think-swagger? ? ? ? ? ? ??? ? ? ? ? ? ? ? ? ? ? ? ? ? ?