首页
/ Scramble项目v0.12.0版本发布:API文档生成工具的重大升级

Scramble项目v0.12.0版本发布:API文档生成工具的重大升级

2025-06-29 10:42:06作者:田桥桑Industrious

Scramble是一个用于自动生成API文档的PHP工具,它能够通过分析代码自动生成符合OpenAPI规范的文档。这个工具特别适合Laravel开发者,能够显著减少手动编写API文档的工作量。最新发布的v0.12.0版本带来了一系列强大的新功能和改进,让API文档生成更加灵活和强大。

端点分组与排序功能增强

新版本引入了#[Group]属性,允许开发者显式地对API端点进行分组和排序。这个改进解决了之前端点排序可能不够直观的问题。现在,开发者可以:

  1. 使用#[Group]属性为相关端点创建逻辑分组
  2. 控制端点在生成文档中的显示顺序
  3. 默认情况下,端点将按照它们在代码中声明的顺序排列

这个功能特别适合大型API项目,能够帮助开发者创建更有组织性的文档结构。

显式命名类基础Schema

通过新增的#[SchemaName]属性,开发者现在可以显式地为基于类的Schema指定名称。这个功能解决了以下问题:

  1. 自动生成的Schema名称可能不够直观
  2. 在不同地方使用相同类时可能产生命名冲突
  3. 需要更精确控制文档中显示的Schema名称

这个改进使得生成的文档更加专业和一致,特别是在团队协作或公共API文档的场景中。

请求参数文档化支持

v0.12.0版本极大地增强了请求参数的文档化能力,引入了多个新属性:

  1. #[QueryParameter] - 用于文档化查询参数
  2. #[HeaderParameter] - 用于文档化请求头参数
  3. #[CookieParameter] - 用于文档化Cookie参数
  4. #[PathParameter] - 用于文档化路径参数
  5. #[BodyParameter] - 专门用于文档化请求体参数

这些属性让开发者能够更精确地描述API参数,包括类型、描述、是否必需等元数据,显著提升了生成文档的准确性和完整性。

类型推断与Schema处理改进

新版本在类型系统方面做了重要改进:

  1. 添加了对self::*类型推断的支持,能够正确处理类内部的自引用类型
  2. 改进了从数组值创建类型的能力,使得复杂数据结构更容易文档化
  3. 确保了类名的一致性,避免了Schema重复的问题

这些改进使得Scramble能够更准确地反映代码中的复杂类型关系,生成更精确的API文档。

实验性新配置API

v0.12.0引入了一个实验性的新配置API,虽然目前还处于早期阶段,但为未来的配置管理提供了更强大和灵活的基础。开发者可以期待在后续版本中看到这个功能的进一步完善。

向后兼容性说明

这个版本包含一个重要的破坏性变更:TypeToSchema扩展和TypeTransformer不再能仅通过类名由容器创建。这是因为TypeTransformer现在依赖于Components类,而后者不再是全局的,而是每个API文档实例独有的。这个变更主要影响那些直接使用Scramble内部组件开发扩展的高级用户,普通用户通常不会受到影响。

总结

Scramble v0.12.0通过一系列新功能和改进,显著提升了API文档生成的灵活性和精确性。从端点分组到参数文档化,再到类型系统增强,这些改进使得Scramble更适合大型、复杂的API项目。对于使用Laravel框架开发API的团队来说,升级到这个版本将能够创建更专业、更易维护的API文档,同时减少手动文档工作的工作量。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8