通过 composer
安装
教程安装的为
2.0
版本,3.0
写法有差异,后面会介绍
composer require zircote/swagger-php:2.0.*
通过代码创建对应的 swagger.json
文件
在框架或者
php
单文件内写入对应的代码(以ThinkPHP
)为例子
use Swagger\Annotations as SWG;
class Index
{
public function index()
{
$swagger=\Swagger\scan(__DIR__); // scan 方法扫描包含注释的代码
$res=$swagger->saveAs('./swagger.json'); // saveAs 方法创建 swagger.json
}
}
下载swagger-ui
前端页面
https://github.com/swagger-api/swagger-ui.git
将压缩包解压到站点上,找到swagger-ui
下的dist/swagger-initializer.js
,修改里面的内容如下
window.onload = function() {
//<editor-fold desc="Changeable Configuration Block">
// the following lines will be replaced by docker/configurator, when it runs in a docker-container
window.ui = SwaggerUIBundle({
url: "自己的配置文件路径", // 将这行修改为自己的配置文件路径
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
});
//</editor-fold>
};
最后访问站点指向的swagger-ui
页面即可