• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# OpenHarmony xxx子系统 xxx API评审申请
2
3## 背景
4
5* API类型：[Public API | System API |Test API| HDI]
6* API需求来源：
7* API使用场景：
8* API所属子系统：
9* API预计发布版本：
10* Contributor：
11* 本次评审涉及的API数量：
12
13| 类型 | 数量 | 编程语言 |
14|---|---|---|
15| 新增 |  |  |
16| 行为变更 | |
17| 废弃 | | |
18| 删除 | | |
19
20## API说明
21
22### 必要性说明
23
24> 现状与差距分析。API的使用场景和价值是什么？
25
26### 总体特性说明
27
28> 相关API完成了哪些功能特性。
29
30## 评审结论
31
32### Committer评审结论
33
34### 领域SIG评审结论
35
36## 自查表
37
38| 自查项 | 自查结果 |
39|---|---|
40| 是否已完成拼写检查？ |  |
41| 是否遵循了编码规范？ | |
42| 词性使用是否正确（名词，形容词，副词）？ | |
43| 命名是否完整表述了API所做的全部逻辑？| |
44|API的参数数量是否合理？（通常少于7个）| |
45|是否合理使用了缩写？（缩写是大家周知的）| |
46|void类型API是否真的考虑过调用者不需要返回值？| |
47|是否考虑过继承体系是合适的？父类的每一个方法都适用于子类| |
48|已定义的错误状态是否完备？| |
49| 命名是否正确使用了对仗词：<br/> add/remove, create/destroy, insert/delete, start/stop, begin/end,  <br/> send/receive, up/down, show/hide, open/close, source/target, <br/>source/destination,  increase/decrease, first/last, next/previous | |
50|新增API与同模块既存API表述和语义层次是否一致？| |
51| 同步API是否需要提供异步版本？ | |
52| 是否每一个public API都真的是开发者需要的？| |
53
54## API接口及说明
55
56> 请填写代码的提交地址。
57
58* 代码地址：
59
60## API权限设计
61
62> 使用该接口是否需要申请相应的权限。
63
64## API隐私保护设计
65
66> 涉及用户隐私，需要考虑隐私保护。
67
68## 开发者指南
69
70> 可选。
71
72## API代码示例
73
74> 二选一即可。
75
76* 代码地址：
77* 代码片段：
78
79## API变更说明
80
81> 新增接口不需要填写此章节。
82
83### 行为变更
84
85> API行为变更是指API的接口没有发生变化，仅仅是行为发生变化。
86> API行为变更需要在新的API版本上进行，不允许破坏旧版本API行为（除非是缺陷修复）。
87
88#### 相关接口
89
90#### 变更原因
91
92### 废弃接口
93
94> 废弃接口的API说明中，需要添加`@deprecated`注解进行（包括：JS/TS/C/C++接口）标记。
95
96#### 相关接口
97
98> 需描述从哪个版本开始标记为废弃。
99
100#### 废弃原因
101
102#### 替代接口
103
104> 如果有则提供，如果无则说明原因。
105
106### 删除接口
107
108> 接口不允许直接删除，需要在标记废弃之后经过5个API版本才允许删除。
109
110#### 相关接口
111
112#### 删除原因
113
114#### 替代接口
115
116> 如果有则提供，如果无则说明原因。
117
118## DFX
119
120### 兼容性
121
122### 性能
123
124### 功耗
125
126### 可靠性
127
128### 可测试性
129
130> API必须同步交付API自动化测试用例，用例100%覆盖API接口。
131
132## 评审结论
133
134* 评审时间：
135* 与会人：
136* 评审结论：[通过|不通过]
137* 评审会议纪要：