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文档,同时减少手动文档工作的工作量。
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C077
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0131
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00