通过 
搜索
搜索dedoc / scramble
Laravel应用程序的API文档自动生成。
v0.11.15
2024-09-22 13:16 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
- dev-main
- v0.11.15
- v0.11.14
- v0.11.13
- v0.11.12
- v0.11.11
- v0.11.10
- v0.11.9
- v0.11.8
- v0.11.7
- v0.11.6
- v0.11.5
- v0.11.4
- v0.11.3
- v0.11.2
- v0.11.1
- v0.11.0
- v0.10.13
- v0.10.12
- v0.10.11
- v0.10.10
- v0.10.9
- v0.10.8
- v0.10.7
- v0.10.6
- v0.10.5
- v0.10.4
- v0.10.3
- v0.10.2
- v0.10.1
- v0.10.0
- v0.9.0
- v0.8.6
- v0.8.5
- v0.8.4
- v0.8.3
- v0.8.2
- v0.8.1
- v0.8.0
- v0.7.2
- v0.7.1
- v0.7.0
- v0.6.0
- v0.5.0
- v0.4.0
- v0.3.0
- v0.2.0
- v0.1.0
- v0.0.2
- v0.0.1
- v0.0.1-alpha.5
- v0.0.1-alpha.4
- v0.0.1-alpha.3
- v0.0.1-alpha.2
- v0.0.1-alpha.1
- dev-feat/new-openapi-class-structure
- dev-226-docs-generation-fails-for-requests-that-utilise-custom-values
This package is not auto-updated.
Last update: 2024-09-22 13:20:58 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- 以JSON格式描述您的API的Open API文档。
默认情况下，这些路由仅在local环境中可用。您可以通过定义viewApiDocs网关来更改此行为。
