Scramble项目v0.12.0版本发布:API文档生成工具的重大升级
Scramble是一个用于自动生成API文档的PHP工具,它能够通过分析代码自动生成符合OpenAPI规范的文档。这个工具特别适合Laravel开发者,能够显著减少手动编写API文档的工作量。最新发布的v0.12.0版本带来了一系列强大的新功能和改进,让API文档生成更加灵活和强大。
端点分组与排序功能增强
新版本引入了#[Group]属性,允许开发者显式地对API端点进行分组和排序。这个改进解决了之前端点排序可能不够直观的问题。现在,开发者可以:
- 使用
#[Group]属性为相关端点创建逻辑分组 - 控制端点在生成文档中的显示顺序
- 默认情况下,端点将按照它们在代码中声明的顺序排列
这个功能特别适合大型API项目,能够帮助开发者创建更有组织性的文档结构。
显式命名类基础Schema
通过新增的#[SchemaName]属性,开发者现在可以显式地为基于类的Schema指定名称。这个功能解决了以下问题:
- 自动生成的Schema名称可能不够直观
- 在不同地方使用相同类时可能产生命名冲突
- 需要更精确控制文档中显示的Schema名称
这个改进使得生成的文档更加专业和一致,特别是在团队协作或公共API文档的场景中。
请求参数文档化支持
v0.12.0版本极大地增强了请求参数的文档化能力,引入了多个新属性:
#[QueryParameter]- 用于文档化查询参数#[HeaderParameter]- 用于文档化请求头参数#[CookieParameter]- 用于文档化Cookie参数#[PathParameter]- 用于文档化路径参数#[BodyParameter]- 专门用于文档化请求体参数
这些属性让开发者能够更精确地描述API参数,包括类型、描述、是否必需等元数据,显著提升了生成文档的准确性和完整性。
类型推断与Schema处理改进
新版本在类型系统方面做了重要改进:
- 添加了对
self::*类型推断的支持,能够正确处理类内部的自引用类型 - 改进了从数组值创建类型的能力,使得复杂数据结构更容易文档化
- 确保了类名的一致性,避免了Schema重复的问题
这些改进使得Scramble能够更准确地反映代码中的复杂类型关系,生成更精确的API文档。
实验性新配置API
v0.12.0引入了一个实验性的新配置API,虽然目前还处于早期阶段,但为未来的配置管理提供了更强大和灵活的基础。开发者可以期待在后续版本中看到这个功能的进一步完善。
向后兼容性说明
这个版本包含一个重要的破坏性变更:TypeToSchema扩展和TypeTransformer不再能仅通过类名由容器创建。这是因为TypeTransformer现在依赖于Components类,而后者不再是全局的,而是每个API文档实例独有的。这个变更主要影响那些直接使用Scramble内部组件开发扩展的高级用户,普通用户通常不会受到影响。
总结
Scramble v0.12.0通过一系列新功能和改进,显著提升了API文档生成的灵活性和精确性。从端点分组到参数文档化,再到类型系统增强,这些改进使得Scramble更适合大型、复杂的API项目。对于使用Laravel框架开发API的团队来说,升级到这个版本将能够创建更专业、更易维护的API文档,同时减少手动文档工作的工作量。
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust069- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
Kimi-K2.6Kimi K2.6 是一款开源的原生多模态智能体模型,在长程编码、编码驱动设计、主动自主执行以及群体任务编排等实用能力方面实现了显著提升。Python00
Hy3-previewHy3 preview 是由腾讯混元团队研发的2950亿参数混合专家(Mixture-of-Experts, MoE)模型,包含210亿激活参数和38亿MTP层参数。Hy3 preview是在我们重构的基础设施上训练的首款模型,也是目前发布的性能最强的模型。该模型在复杂推理、指令遵循、上下文学习、代码生成及智能体任务等方面均实现了显著提升。Python00