更新 SwiftUI API
通过 Sosumi MCP 系统扫描 Apple 的开发者文档,识别已弃用的 SwiftUI API 及其现代替代方案,并更新 swiftui-expert-skill/references/latest-apis.md。
前提条件
- Sosumi MCP 必须启用并可用(提供
searchAppleDocumentation、fetchAppleDocumentation、fetchAppleVideoTranscript、fetchExternalDocumentation) - 对此仓库(或其分支)的写权限
工作流程
1. 了解当前覆盖范围
阅读 swiftui-expert-skill/references/latest-apis.md 以了解:
- 哪些已弃用到现代的转换已被记录
- 正在使用的版本分段(iOS 15+、16+、17+、18+、26+)
- 底部的快速查询表
2. 加载扫描清单
读取 references/scan-manifest.md(相对于此技能)。它包含分类的 API 区域列表、文档路径、搜索查询以及要扫描的 WWDC 视频路径。
3. 扫描 Apple 文档
对于清单中的每个类别:
- 调用
searchAppleDocumentation并传入列出的查询,以发现相关页面。 - 调用
fetchAppleDocumentation并传入具体的文档路径,以获取完整的 API 详细信息。 - 查找弃用通知、“已弃用”标签以及“改用 ... ”的指导。
- 记录现代替代方案可用的 iOS 版本。
- 可选地调用
fetchAppleVideoTranscript获取公布 API 变更的 WWDC 会议记录。
为提高效率,批量执行相关搜索。重点查找新的弃用项,即尚未包含在 latest-apis.md 中的项。
4. 比较并识别变更
将发现与现有条目进行比较。将结果分类:
- 新的弃用项:尚未在
latest-apis.md中记录的 API - 更正项:需要更新的现有条目(版本错误、更好的替代方案可用)
- 新的版本分段:如果新 iOS 版本引入了弃用,则添加新的章节
5. 更新 latest-apis.md
严格遵循既定格式。每个条目必须包含:
章节位置 -- 放置在正确的版本分段下:
- “始终使用(iOS 15+)”用于长期弃用的 API
- “当目标为 iOS 16+” / “17+” / “18+” / “26+” 用于版本限制的变更
条目格式:
**始终使用 `modernAPI()` 代替 `deprecatedAPI()`。**
\```swift
// 现代方式
View()
.modernAPI()
// 弃用方式
View()
.deprecatedAPI()
\```
快速查询表 -- 在文件底部添加一行:
| `deprecatedAPI()` | `modernAPI()` | iOS XX+ |
保持文件顶部的署名行:
基于使用 Sosumi MCP 对 Apple 文档的比较,我们找到了最新推荐的 API。
6. 创建拉取请求
- 从
main创建分支,命名为update/latest-apis-YYYY-MM(使用当前年月)。 - 提交对
swiftui-expert-skill/references/latest-apis.md的更改。 - 通过
gh pr create创建 PR,包含:- 标题:“更新最新 SwiftUI API(月份 年份)”
- 正文:新增/更改条目的摘要,并对 Sosumi MCP 进行署名
Sosumi MCP 工具参考
| 工具 | 参数 | 返回 |
|---|---|---|
searchAppleDocumentation | query(字符串) | 包含 results[] 的 JSON,字段为 title、url、description、breadcrumbs、tags、type |
fetchAppleDocumentation | path(字符串,例如 /documentation/swiftui/view/foregroundstyle(_:)) | Markdown 格式的文档内容 |
fetchAppleVideoTranscript | path(字符串,例如 /videos/play/wwdc2025/10133) | Markdown 格式的转录内容 |
fetchExternalDocumentation | url(字符串,完整的 https URL) | Markdown 格式的文档内容 |
提示
- 从使用
searchAppleDocumentation查询开始广泛搜索,然后使用fetchAppleDocumentation深入特定的路径。 - Apple 的弃用文档通常会在页面中显示“已弃用”,并链接到替代方案。
- WWDC“SwiftUI 新特性”会议是获取新引入替代方案的最佳来源。
- 如果对某个弃用项的确切 iOS 版本不确定,请通过检查获取的文档中的“可用性”部分来验证。
- 如果 API 已弃用但没有直接的替代方案,则应注明,而不是建议不正确的替代方案。