dedoc/scramble
Composer 安装命令：
composer require dedoc/scramble
包简介
Automatic generation of API documentation for Laravel applications.
README 文档
README
Scramble
Scramble generates API documentation for Laravel project. Without requiring you to manually write PHPDoc annotations. Docs are generated in OpenAPI 3.1.0 format.
Documentation
You can find full documentation at scramble.dedoc.co.
Introduction
The main motto of the project is generating your API documentation without requiring you to annotate your code.
This allows you to focus on code and avoid annotating every possible param/field as it may result in outdated documentation. By generating docs automatically from the code your API will always have up-to-date docs which you can trust.
Installation
You can install the package via composer:
composer require dedoc/scramble
Usage
After install you will have 2 routes added to your application:
/docs/api- UI viewer for your documentation/docs/api.json- Open API document in JSON format describing your API.
By default, these routes are available only in local environment. You can change this behavior by defining viewApiDocs gate.
dedoc/scramble 适用场景与选型建议
dedoc/scramble 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 11.79M 次下载、GitHub Stars 达 2.14k， 最近一次更新时间为 2022 年 08 月 19 日， 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向： 「documentation」 「laravel」 「openapi」 等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 dedoc/scramble 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 dedoc/scramble 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
与 dedoc/scramble 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：
Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting
Laravel package that generates RESTful API documentation in Markdown based on PHPDoc.
Laravel API documentation generating tool
The following pages give you some general information on how to use our APIs.<br/>The actual API services documentation then follows further below. You can use the menu to jump between API sections.<br/><br/>This page has a built-in HTTP(S) client, so you can test the services directly from within t
Alfabank REST API integration
RESTful API server for structured and self-documenting resources over JSON, XML, ...
统计信息
- 总下载量： 11.79M
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 2146
- 点击次数： 18
- 依赖项目数： 83
- 推荐数： 4
其他信息
- 授权协议： MIT
- 更新时间： 2022-08-19