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文档,同时减少手动文档工作的工作量。
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~044CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。06GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0300- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选









