README

这里应该是你的描述。查看 contributing.md 以获取待办事项清单。

要求

Laravel 5.5 及以上版本

安装

通过 Composer

$ composer require harlekoy/apidocs

安装 API Docs 后，使用 apidocs:install Artisan 命令发布其资产和迁移文件。

$ php artisan apidocs:install

更新 API Docs

更新时，应重新发布 API Docs 的资产

$ php artisan apidocs:publish

重新读取 API 路由

更新您的 API 文档路由列表时，您应运行此命令以获取最新的 Laravel route:list

$ php artisan apidocs:routes

用法

在浏览器中访问您的 API 文档

/apidocs/list

如果您在您的计算机上没有运行任何本地服务器，请在命令行工具中首先运行此命令 php artisan serve，然后它会生成此 http://127.0.0.1:8000。现在您可以使用该主机名访问路径 http://127.0.0.1:8000/apidocs/list，享受使用它吧 😄。

变更日志

请参阅 changelog 了解最近更改的详细信息。

测试

$ composer test

贡献

请参阅 contributing.md 了解详细信息及待办事项清单。

安全

如果您发现任何安全相关的问题，请通过电子邮件 me@harlekoy.com 而不是使用问题跟踪器。

鸣谢

路线图

Laravel API Docs 仍在开发中，我决定在这个早期阶段发布它，以便您可以帮助我使其更好。然而，您可以在生产环境中使用它。让我们完成下面的任务，以便我们可以有一个带有所需功能的正确功能的版本 1 运行起来。

以下是即将到来的计划

添加 API Docs 自定义路径支持
为组和端点手风琴添加过渡效果
在 Web 界面中添加编辑 API Docs 组和端点的方法
添加测试。
添加对必需参数的验证

许可

许可。请参阅许可文件了解更多详细信息。

harlekoy / apidocs

维护者

详细信息

README

要求

安装

更新 API Docs

重新读取 API 路由

用法

变更日志

测试

贡献

安全

鸣谢

路线图

许可