0

0

分享一个ThinkPHP SwaggerV3扩展包

藏色散人

藏色散人

发布时间:2021-09-17 16:01:51

|

2052人浏览过

|

来源于learnku

转载

下面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触发如下代码

toYaml();

本地导入composer

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

 "minimum-stability": "dev"

repositories 加入

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

创建控制器

在src 创建 一个Controller.php

一个是展示 html 的,一个是提供swagger api 接口的

具体代码可查阅:

微尔企业网站管理系统1.75 build build 090709
微尔企业网站管理系统1.75 build build 090709

系统功能介绍 1 包含企业网站所必备的功能:企业信息、产品管理、人才招聘、新闻资讯、企业图片、以及视频下载等模块2 由于是从CMS系统的基础上开发而成,因此相对于一些其他的企业网站管理系统,本系统具备更强的可扩展能力,可以胜任从小型工作室到大中型企业网上门户等各种不同规模网站的需求。3 后台管理与模板完全分离,并具备非常灵活的标签技术,可以实现无限制个性化的界面定制4 操作简单,利用已经制作好的模

下载

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

添加路由

    "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项目再把这个包升级一下吧。

源码:https://github.com/liaoshengping/think-swagger                                           

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

Golang 性能分析与pprof调优实战
Golang 性能分析与pprof调优实战

本专题系统讲解 Golang 应用的性能分析与调优方法,重点覆盖 pprof 的使用方式,包括 CPU、内存、阻塞与 goroutine 分析,火焰图解读,常见性能瓶颈定位思路,以及在真实项目中进行针对性优化的实践技巧。通过案例讲解,帮助开发者掌握 用数据驱动的方式持续提升 Go 程序性能与稳定性。

9

2026.01.22

html编辑相关教程合集
html编辑相关教程合集

本专题整合了html编辑相关教程合集,阅读专题下面的文章了解更多详细内容。

56

2026.01.21

三角洲入口地址合集
三角洲入口地址合集

本专题整合了三角洲入口地址合集,阅读专题下面的文章了解更多详细内容。

51

2026.01.21

AO3中文版入口地址大全
AO3中文版入口地址大全

本专题整合了AO3中文版入口地址大全,阅读专题下面的的文章了解更多详细内容。

397

2026.01.21

妖精漫画入口地址合集
妖精漫画入口地址合集

本专题整合了妖精漫画入口地址合集,阅读专题下面的文章了解更多详细内容。

118

2026.01.21

java版本选择建议
java版本选择建议

本专题整合了java版本相关合集,阅读专题下面的文章了解更多详细内容。

3

2026.01.21

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

16

2026.01.21

C++多线程相关合集
C++多线程相关合集

本专题整合了C++多线程相关教程,阅读专题下面的的文章了解更多详细内容。

11

2026.01.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号