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 StartedRust0191
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0114
Step-3.7-FlashStep-3.7-Flash是一个拥有 1980 亿参数的稀疏混合专家(MoE)视觉语言模型,由 1960 亿参数的语言主干网络和 18 亿参数的视觉编码器组合而成,具备原生图像理解能力。Python00
JoyAI-EchoJoyAI-Echo,这是一个独立的、仅用于推理的版本,旨在实现分钟级多镜头音视频生成。它采用了经过蒸馏的DMD生成器、配对的跨模态记忆以及故事级别的一致性。其性能的核心在于,一个跨模态视听记忆库能够在长达五分钟的视频中保持角色外观和语音音色的一致性。同时,一个训练后处理流程将基于记忆的强化学习与分布匹配蒸馏相结合,实现了7.5倍的速度提升,显著增强了视觉质量和对齐效果。00
omega-aiOmega-AI:基于java打造的深度学习框架,帮助你快速搭建神经网络,实现模型推理与训练,引擎支持自动求导,多线程与GPU运算,GPU支持CUDA,CUDNN。Java04
llm-universe本项目是一个面向小白开发者的大模型应用开发教程,在线阅读地址:https://datawhalechina.github.io/llm-universe/Jupyter Notebook08