• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# API扫描工具
2
3## 简介
4
5本文主要介绍API扫描工具，它可以扫描三方库中包含OpenHarmony源码不包含的接口，并输出result.xlsx文档。开发者移植三方库到OpenHarmony源码中，若三方库中包含一些OpenHarmony中不存在的接口，便会增加移植难度。此时可使用API扫描工具，提前预知风险接口，降低移植难度，提高开发效率。目前工具支持VS Code插件一种入口。
6
7更多工具的架构和实现原理详情，可以左键单击以下链接了解：
8
9[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/tool/api/docs/INSTRUCTION_ZH.md)
10
11	├── napi_generator
12	│   ├── ...                                  # 其它文档
13	│   ├── src/tool
14	│   │   ├── api                              # api扫描工具
15	│   │   |   ├── api_scan_vs_plugin           # VS Code插件源码
16	│   │   |   ├── ...
17
18## 约束
19系统：建议Ubuntu 20.04或者Windows 10
20
21依赖版本：VS Code 1.62.0
22
23## 使用方法
24
25### 使用对象
26
27系统开发者
28
29### 使用场景
30
31移植三方库到OpenHarmony前预知风险接口。
32
33### 工具使用
34
35工具支持VS Code插件，可在VS Code插件市场直接下载。
36
37具体的工具使用步骤，可以左键单击以下链接了解：
38
39[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/tool/api/api_scan_vs_plugin/docs/INSTRUCTION_ZH.md)
40
41### 工具输出
42
43根据使用者指定三方库项目源码，工具会输出风险接口。为了方便使用者快速上手工具，此处使用opencv项目为例，项目目录如下：
44
45![](./figures/opencv.png)
46
47在window环境下的，根据输入三方库项目,生成的输出文件result.xlsx，如下所示：
48
49![](./figures/opencv_result.png)
50
51其中生成的result.xlsx文件，风险接口如下所示：
52
53![](./figures/opencv_include.png)
54
55![](./figures/opencv_h.png)
56
57## 版本说明
58
59暂无
60
61## FAQ
62
63  [FAQ](https://gitee.com/openharmony/napi_generator/tree/master/src/tool/api/FAQ.md)
64
65## 参与贡献
66
67暂无
68
69## 相关仓
70
71暂无
72