写一个ThinkPHP SwaggerV3 扩展包
0 / 0 / 创建于 3年前 /
liaosp 的个人博客
目录#
大致过程和我之前写的 Laravel 扩展差不多 Laravel 写一个中文验证扩展包
只有一些小小的区别这边写个教程。希望为 thinkphp 开发者做一点点贡献。
主要讲一些开发的过程和一些❤感悟吧，对 Tp 不是特别熟，欢迎大家指正（づ￣3￣）づ╭❤～
源码：github.com/liaoshengping/think-swa...
安装：
composer require liaosp/think-swagger -vvv
创建包#
🌰
我在 tp 的根目录下创建 pkg
mkdir pkg
cd pkg
package-builder build think-swagger添加 zircote/swagger-php，在 composer.json 添加
添加 swagger#
"require": {
"zircote/swagger-php": "^3.2"
},根据 官网的示例，我们希望在 TP 触发如下代码
<?php
require("vendor/autoload.php");
$openapi = \OpenApi\Generator::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": "pkg\\think-swagger"
}创建控制器#
在 src 创建 一个 Controller.php
一个是展示 html 的，一个是提供 swagger api 接口的
具体代码可查阅：
github.com/liaoshengping/think-swa...
添加路由#
"autoload": {
"psr-4": {
"Liaosp\\ThinkSwagger\\": "src"
},
"files": [
"src/route.php"
]
},添加 router.php
tp5 我现在的版本可以这样做，但是 TP6 我试了下，不行啊报错；如果后面有 Tp6 项目了，我会把 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
静态形式引用 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": [
"Liaosp\\ThinkSwagger\\Service"
]
}
}
不过 Laravel 之前也需要手动添加 Provider，希望国产 Tp 越来越好，目前我测试了下这个包可以在 Tp5 运行，tp6 不行。后面再看看有没有接触 TP6 项目再把这个包升级一下吧。
源码：github.com/liaoshengping/think-swa...
本作品采用《CC 协议》，转载必须注明作者和本文链接
关于 LearnKu
粤公网安备 44030502004330号
推荐文章：