学习 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

评论() 相关

收藏

赞

浪荡的柚子

ThinkPHP 是一个免费开源的,快速、简单的面向对象的 轻量级PHP开发框架 ,创立于2006年初,遵循Apache2开源协议发布,是为了敏捷WEB应用开发和简化企业应用开发而诞生的。ThinkPHP从诞生以来一直秉承简洁实用的设计原则,在保持出色的性能和至简的代码的同时,也注重易用性。并且拥有众多的原创功能和特性,在社区团队的积极参与下,在易用性、扩展性和性能方面不断优化和改进,已经成长为国内最领先和最具影响力的WEB应用开发框架,众多的典型案例确保可以稳定用于商业以及门户级的开发。