通过
搜索
搜索justcoded / scramble
为Laravel应用程序自动生成API文档。
dev-main
2024-09-20 14:09 UTC
Requires
- php: ^8.1
- illuminate/contracts: ^10.0|^11.0
- myclabs/deep-copy: ^1.12
- nikic/php-parser: ^5.0
- phpstan/phpdoc-parser: ^1.0
- spatie/laravel-package-tools: ^1.9.2
Requires (Dev)
- laravel/pint: ^v1.1.0
- nunomaduro/collision: ^7.0|^8.0
- orchestra/testbench: ^8.0|^9.0
- pestphp/pest: ^2.34
- pestphp/pest-plugin-laravel: ^2.3
- phpunit/phpunit: ^10.5
- spatie/pest-plugin-snapshots: ^2.1
This package is auto-updated.
Last update: 2024-09-25 14:58:39 UTC
README
分支自 https://github.com/dedoc/scramble. 改进了一些类，使其能够扩展，过滤结果，并使用单个类来生成OAS部分文档，而不是整个文档。
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格式。
默认情况下，这些路由仅在local环境中可用。您可以通过定义viewApiDocs网关来更改此行为。
