README

生成并验证您的 OpenAPI 文档。以您熟悉的方式构建 OpenAPI 文档，即 PHP 数组。您不需要为所有模块制作静态文档，并始终显示，而可以使用此生成器仅根据您当前安装的模块生成文档。

当安装新模块时，您可以再次生成文档，将那个模块的文档注入到更大的系统中。

此外，它还配备了 Redoc (Github)，因此您的客户端在集成 API 时可以拥有一个美观的用户界面。

安装

您可以通过 composer 安装此包。

composer require rockymontana/oa-documentor

php artisan openapi:generate

如果您想试用它，可以将 tests 中的 docs 文件夹复制到您的项目根目录，然后运行生成命令。

然后您可以根据需要调整文档，添加新的路径文件和组件。完成操作后，重新生成文档并在浏览器中查看。

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

请参阅 CONTRIBUTING 了解详细信息。

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

MIT 许可证 (MIT)。有关更多信息，请参阅许可文件。