README

项目介绍

此module是用于显示REST接口文档的

easy-api-docs 是一个easy framework 示例扩展，用于接口开发时的接口文档展示

安装

使用composer。

在项目中 composer.json 文件中添加依赖：

"require":{
  "wallesoft/easy-api-docs":"*"
}

执行 $ php composer.phar update 或 $ composer update 安装
配置：在应用的配置文件中（配置文件路径 your_app_directory/config/main.php）添加配置到module中

然后在配置文件中添加配置信息到module中


'modules'=> [
  'docs'=> [
    'class'=>'wallesoft\easy\rest\module\DocsModule',
    'projectDir'=> dirname(__FILE__).'/../controllers',
    'apiName' => 'App',
  ]

用法

查看在线文档

http://your_domain.com/index.php?r=docs // 总接口目录列表启动 r=docs 为在module配置中的名称 http://your_domain.com/index.php?r=docs&service=api/index // 详细接口页面

访问可以通过URL重写优化访问方式

待办事项列表

完成

1.接口分类列表页显示

2.接口详细参数及调试

可能

1.命令行模式生成本地文档

wallesoft / easy-api-docs

维护者

详细信息

README

项目介绍

安装

使用composer。

用法

待办事项列表

完成

可能