onetechasia/laravel-export-docs

使用 Laravel 自动生成文档系统

v1.0.6 2023-08-29 04:48 UTC

This package is auto-updated.

Last update: 2024-09-15 11:41:40 UTC


README

您可以通过 composer 安装此包。

composer require onetechasia/laravel-export-docs

要求

此包需要 graphviz 工具。

您可以通过 homebrew 在 MacOS 上安装 Graphviz

brew install graphviz

为了使用 Chat GPT 翻译文档

添加到 .env: OPENAI_API_KEY=sk-xxxxx

导出数据库图

php artisan docs:diagram

检查存储/app/export/database/ 中的文件

导出数据库文档

php artisan docs:database

检查存储/app/export/database/ 中的文件

API 文档尚未发布

php artisan docs:api-spec --collection=url-collection-postman-required --environment=path/postman-environment.json

注意:postman 环境必须包含 token 登录 检查存储/app/export/api/ 中的文件