通过以下链接搜索 
xhieudev / scramble
Laravel应用程序的API文档自动生成。
dev-main
2024-06-25 07:30 UTC
Requires
- php: ^7.4|^8.0|^8.1
- illuminate/contracts: ^8.0.0|^9.0.0|^10.0.0
- nikic/php-parser: ^4.0
- phpstan/phpdoc-parser: ^1.0
- spatie/laravel-package-tools: ^1.9.2
Requires (Dev)
- doctrine/dbal: ^3.4
- laravel/pint: ^v1.1.0
- nunomaduro/collision: ^5.0|^v6.0
- orchestra/testbench: ^6.0|^7.0|^8.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.2
- phpunit/phpunit: ^9.5
- spatie/pest-plugin-snapshots: ^1.1
This package is auto-updated.
Last update: 2024-09-25 07:57:59 UTC
README
Scramble
Scramble为Laravel项目生成API文档。无需手动编写PHPDoc注释。文档以OpenAPI 3.1.0格式生成。
警告 包处于早期阶段。这意味着可能存在错误，API也可能发生很大变化。如果发现错误，请创建问题。欢迎提出建议。
文档
您可以在scramble.dedoc.co找到完整文档。
简介
项目的主要宗旨是无需您对代码进行注释即可生成API文档。
这使您能够专注于代码，避免注释每个可能的参数/字段，因为这可能会导致文档过时。通过从代码中自动生成文档，您的API将始终拥有最新且可信赖的文档。
安装
您可以通过composer安装此包
composer require dedoc/scramble
用法
安装后，您将在应用程序中添加2个路由
/docs/api- 文档的UI查看器/docs/api.json- 描述您的API的Open API文档（JSON格式）。
