Laradoc - Laravel 项目的 API 文档管理器
Laradoc 简化了 Laravel 项目的 API 文档管理。它生成、托管并安全地管理对API文档的访问,同时让您的团队了解对端点所做的最新更改。
Laradoc 是什么?
Laradoc让您轻松享受OpenAPI的好处。它从您的Laravel项目中生成OpenAPI规范,并使您免于手工编写这些规范的繁琐任务。
您的API文档将始终是准确和最新的。
生成OpenAPI规范后,您可以选择下载它们或通过文档查看器访问它们。
要求
- PHP >= 7.4
- Laravel >= 8.0
- 托管于 Github 或 GitLab 的 Git 仓库
它是怎么工作的?
对您的项目的分析是在我们的基础设施上进行的,在一个短暂的容器化环境中,执行以下步骤:
- 项目安装
- 静态分析
- 运行项目测试 (PHPUnit or Pest)
- 结果汇总和处理
- 生成 OpenAPI 文档
NO WORRIES
您不需要在项目中进行测试。但是,它们有助于为请求 body 参数和响应创建准确的示例。
Laradoc并不局限于生成OpenAPI文档。它提供了涵盖API文档所有方面的全面体验,包括托管、合作者的访问管理、Git分支集成、CI/CD集成、用于进行最终润色的编辑器,或用于跟踪新更改的更改日志生成器。