SuperAPI AI 工具集

apple-docs-index

编程与开发

查看项目

更新于 10-15 14:36

技能介绍

用途

apple-docs-index 是一个 Apple 开发者文档索引技能,面向 iOS、macOS 及相关框架的文档查阅场景。它的核心作用是提供各框架文档的索引,帮助开发者:浏览某个框架中可用的 API、查找特定文档的路径、判断需要下载哪些详细文档。

主要能力

该技能提供以下框架的索引文件:

  • SwiftUI:文件为 ../swiftui/swiftui-overview.md,大小 907KB,涵盖视图、修饰符、导航、状态。
  • XCTest:文件为 xctest-index.md,大小 55KB,涵盖测试、断言、期望。
  • XCUIAutomation:文件为 xcuiautomation-index.md,大小 58KB,涵盖 UI 测试、元素、查询。
  • UIKit:文件为 ../uikit/uikit-overview.md,大小 1.8MB,涵盖视图、控制器、控件、场景。
  • Core Animation:文件为 ../core-animation/core-animation-index.md,大小 80KB,涵盖 CALayer、CAAnimation、CATransaction、图层子类。
  • HealthKit:文件为 healthkit-index.md,大小 312KB,涵盖健康数据、锻炼、记录。
  • Combine:文件为 combine-index.md,大小 153KB,涵盖发布者、订阅者、操作符。
  • SwiftData:文件为 swiftdata-index.md,大小 86KB,涵盖模型、容器、查询。
  • Observation:文件为 observation-index.md,大小 3KB,涵盖 @Observable 宏。

使用方式

1. 浏览索引

可以使用命令行查看索引内容,例如查看 HealthKit 索引的前 100 行:

cat healthkit-index.md | head -100

也可以搜索特定主题:

grep -i "workout" healthkit-index.md
grep -i "navigation" ../swiftui/swiftui-overview.md

2. 查找文档路径

索引文件会列出所有可用的文档页面,每个条目显示路径,例如:

3. 获取更详细的文档

先检查详细页面是否已存在于已安装的 Apple 技能中。可通过技能名称、描述或 SKILL.md frontmatter 找到可能的技能目录,然后 grep 其本地 .md 文件,这比从互联网获取新文档更快且占用更少上下文。

如果已安装的技能中没有该页面,可使用相同路径配合 sosumi.ai Markdown 镜像。例如,/documentation/healthkit/hkworkout 对应 https://sosumi.ai/documentation/healthkit/hkworkout。

4. 浏览缺失的框架索引

如果本地索引不包含所需框架,可使用该框架的 sosumi.ai 索引:

https://sosumi.ai/documentation/{framework}

例如,https://sosumi.ai/documentation/foundation 提供可搜索 Foundation 路径的 Markdown 索引。

如果 Markdown 镜像不可用且环境可解析 JSON,Apple 公开的 DocC 索引端点为:

https://developer.apple.com/tutorials/data/index/{framework}

有用的路径树位于 interfaceLanguages.swift[0].children 下。

适用场景

适用于需要查阅 Apple 框架 API 的开发者,尤其是在编写 SwiftUI、UIKit、HealthKit、Combine、SwiftData 等框架相关代码时,快速定位可用 API 和文档路径。也适用于需要判断下载哪些详细文档、或在本地技能中检索已有文档的场景。

限制

资料未提供该技能的收费、价格、平台支持范围、效果保证等信息。索引文件的具体内容、更新频率、覆盖完整性等暂未提供。