fanrehai/showapi

There is no license information available for the latest version (0.4.2) of this package.

auto api doc

0.4.2 2020-11-17 09:51 UTC

Requires

• php: >=5.6
• ext-curl: *

Unknown License

• fanrehai

• php
• api doc

README

这是一个根据代码返回结果自动生成文档的插件

composer安装

composer require fanrehai/showapi

$apiKey   = '7d3*******************134';
$apiToken = 'a59*******************110';
$apiUrl   = 'https://yourwebsite/server/index.php?s=/api/item/updateByApi';
$projectUrl = '*****';
$fileMax = '10';
$api      = new ApiDoc($apiKey, $apiToken, $apiUrl, $projectUrl, $fileMax);

这是调用前的基础配置，

1. apiKey 和 apiToken 可以在项目 -> 项目设置 -> 开放API 中获取，
2. apiUrl 这个是自动文档的网站地址，可以为私有部署服务器，也可以为showdoc官方网址(https://www.showdoc.cc/)
3. fileMax是限制文件大小参数，当超过限制大小时会返回一个错误信息，单位是MB

• $api->saveApiToLog( '控制器名称', '函数名称', ['参数名称', '参数名'] , '函数介绍', '接口访问地址');

saveApiToLog方法会把接口信息保存在文件中，等待下一次调用 用法：

$api->saveApiToLog( 'Login', 'login', ['name', 'password'] , '用户基本登录接口', 'index/index');

• $api->saveApiToWeb('控制器名称', '函数名称', 返回的参数，数组的格式，是否直接输出(默认为false));

saveApiToWeb方法会把保存在文件中的接口转成markdown格式之后，上传至服务器保存或者直接输出markdown格式 用法：

$api->saveApiToWeb('Login', 'login', $data);
$api->saveApiToWeb('Login', 'login', $data, true);

• $api->saveApiClear();这个方法用于清空文件中的内容

$api->saveApiClear();

• 为方便参数的翻译，项目内有一个语言文件夹，修改里面的文件会替换所有接口的参数翻译后的名称。可自行扩展 :)