Scramble项目中的整数类型输出优化

在API文档生成工具Scramble的最新版本中，开发团队修复了一个关于整数类型输出的细节问题。这个问题涉及到API响应中整数类型字段的文档表示方式。

问题背景

在API开发中，数据类型的选择和明确表示对于API使用者至关重要。当使用Scramble生成API文档时，开发者发现对于PHP中定义为int类型的字段，在生成的文档中被表示为更通用的number类型。虽然从技术上讲，整数确实是数字的一种，但这种表示方式缺乏精确性，可能会给API使用者带来困惑。

技术细节

在PHP中，整数(int)和浮点数(float)是两种不同的基本数据类型。当使用Scramble的Data类定义API响应结构时，例如：

class UnreadNotificationsCountResponse extends Data
{
    public function __construct(
        public int $notificationsCount,
        public int $threadsCount,
        public int $archivedThreadsCount,
    ) {}
}

开发者明确指定了这些字段为整数类型。然而，在之前的版本中，生成的文档将这些字段标记为number类型，这不够精确。

解决方案

Scramble团队在0.6.7版本中修复了这个问题。现在，当字段被定义为int类型时，生成的文档会正确地将其标记为integer类型，而不是更宽泛的number类型。这种改进使得API文档更加准确和专业。

升级建议

对于使用Scramble-Pro的用户，建议将包版本升级到^0.6.7以获取这一改进。这一变更属于细节优化，不会影响现有API的功能，但能提供更准确的文档信息。

总结

数据类型表示的准确性是API文档质量的重要指标。Scramble团队对整数类型输出的优化体现了对细节的关注，这种改进有助于提升开发者体验和API文档的专业性。对于API工具的使用者来说，保持工具的最新版本是获取最佳实践和修复的重要方式。