apidoc中文版php,Api--doc

本文档介绍了如何在ThinkPHP5.0和5.1项目中使用Api-doc扩展生成接口文档。包括安装扩展、配置参数、添加注释以及查看生成的接口文档。
摘要由CSDN通过智能技术生成

# Api-doc 文档自动生成(针对 thinkphp5.0 / 5.1)

摘自: [https://github.com/zhangweiwei0326/api-doc](https://github.com/zhangweiwei0326/api-doc)

#api-doc

### [](https://github.com/zhangweiwei0326/api-doc#%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95)使用方法

####1、安装扩展

~~~

composer require weiwei/api-doc

~~~

####2、配置参数

* 5.0安装好扩展后在 application\\extra\\ 文件夹下会生成 doc.php 配置文件

* 5.1安装好扩展后在 application\\config\\ 文件夹下会生成 doc.php 配置文件

* 在controller参数中添加对应的类

~~~

'controller' => [

'app\\api\\controller\\Demo' //这个是控制器的命名空间+控制器名称

]

~~~

####3、在相关接口类中增加注释参数( group 参数将接口分组,可选)

* 方法如下:返回参数支持数组及多维数组

~~~

namespace app\index\controller;

use think\Controller;

/**

* @title 测试demo

* @description 接口说明

* @group 接口分组

Laravel API Documentation Generator 是一个用于生成 API 文档的工具,它可以基于 Laravel 项目中的路由、控制器和注释来创建文档。自定义生成的 API 文档样式和布局主要可以通过编辑生成器使用的模板文件来实现。以下是自定义样式和布局的一些步骤和建议: 1. **获取模板文件**: 你可以通过克隆 laravel-apidoc-generator 的 GitHub 仓库来获取默认的模板文件。模板文件定义了文档的结构和样式,通常包括 HTML 和 Markdown 文件。 ```bash git clone https://github.com/mpociot/laravel-apidoc-generator.git ``` 2. **修改模板文件**: 在获取模板文件后,你可以根据需要对其进行编辑,比如调整 HTML 结构、CSS 样式或者添加自定义的 JavaScript 脚本。这些模板文件通常位于 `resources/views` 文件夹内。 3. **配置生成器**: 当你安装了 laravel-apidoc-generator 并配置了 API 的路由和注释后,你可以在 `php artisan apidoc:generate` 命令执行时使用 `--template_folder` 选项指定你的自定义模板文件夹路径。 ```bash php artisan apidoc:generate --template_folder={path/to/your/template} ``` 4. **添加自定义样式和脚本**: 在模板文件中,你可以添加自定义的 CSS 链接或者 JavaScript 引用来进一步定制文档的外观和行为。确保这些资源在生成的文档中能够正确加载。 5. **更新依赖**: 如果你修改了模板并添加了新的资源文件,确保这些更改被正确处理,并且在生成文档时不会出现资源未找到的错误。 6. **测试你的更改**: 在自定义了样式和布局之后,运行生成命令并检查文档以确保所有更改都按预期工作。如果有任何问题,需要返回编辑模板文件进行调试。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值