大橙子网站建设,新征程启航
为企业提供网站建设、域名注册、服务器等服务
下面由thinkphp教程栏目给大家介绍thinkphp5集成Swagger-PHP(排坑),希望对需要的朋友有所帮助!
目前创新互联已为上1000家的企业提供了网站建设、域名、网络空间、网站托管维护、企业网站设计、大庆网站维护等服务,公司将坚持客户导向、应用为本的策略,正道将秉承"和谐、参与、激情"的文化,与客户和合作伙伴齐心协力一起成长,共同发展。学习 Swagger 过程中发现网上大部份的资料都不是特别全,所以特别发文把自己的排坑历程写出来,希望能对大家有帮助。
1、安装swagger-php2.0
(注:我下载的是swagger-php2.0,本文针对swagger-php2.0)
composer require zircote/swagger-php: 2.0.*
2、下载swagger-ui
去swagger-ui官网下载静态页面,把静态页面放到thinkphp框架目录里,例如public目录。
https://swagger.io/tools/swagger-ui/
3、thinphp框架引入swagger-php,生成swagger.json文件
use Swagger\\Annotations as SWG; class Index { public function index() { $swagger=\\Swagger\\scan(__DIR__); $res=$swagger->saveAs('./swagger.json'); }
4、文档注释部分
/** * @SWG\\Swagger( * schemes={"http"}, * host="www.tp.com.cn/", * basePath="/", * @SWG\\Info( * title="API文档", * version="1.0.0", * ) * ), */
详细关于Swgger-php的使用说明请访问
https://www.kancloud.cn/chengguang/swagger-php#/catalog