1# API扫描工具 2 3## 简介 4 5本文主要介绍API扫描工具，它可以扫描三方库中包含OpenHarmony源码不包含的接口，并输出result.xlsx文档。开发者移植三方库到OpenHarmony源码中，若三方库中包含一些OpenHarmony中不存在的接口，便会增加移植难度。此时可使用API扫描工具，提前预知风险接口，降低移植难度，提高开发效率。目前工具支持可执行文件、VS Code插件、IntelliJ插件三种入口。 6 7更多工具的架构和实现原理详情，可以左键单击以下链接了解： 8 9[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/api/docs/INSTRUCTION_ZH.md) 10 11 ├── napi_generator # NAPI框架代码生成工具 12 │ ├── ... # 其他文档 13 │ ├── hdc 14 │ │ ├── ... # 其他工具 15 │ │ ├── api # api扫描工具 16 │ │ | ├── api_scan_vs_plugin # VS Code插件源码 17 │ │ | ├── api_scan_IntelliJ_plugin # Intellij插件源码 18 │ │ | ├── src # 工具源码 19 │ │ | | ├── scan.js # 工具源码入口 20 │ │ | | ├── package.json # package.json文件 21 22## 约束 23系统：建议Ubuntu 20.04或者Windows 10 24 25依赖版本：VS Code 1.62.0 26 27## 使用方法 28 29### 使用对象 30 31系统开发者 32 33### 使用场景 34 35移植三方库到OpenHarmony前预知风险接口。 36 37### 工具使用 38 39工具有三种类型，分别是可执行文件、VS Code插件、IntelliJ插件。其中的可执行文件可根据工具使用者的开发环境选择，支持Windows，Linux和Mac。可执行文件、IntelliJ插件、VS Code插件下载路径如下： 40 41[下载链接](暂无) 42 43具体的工具使用步骤，可以左键单击以下链接了解： 44 45[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/api/docs/INSTRUCTION_ZH.md) 46 47### 工具输出 48 49根据使用者指定三方库项目源码，工具会输出风险接口。为了方便使用者快速上手工具，此处使用opencv项目为例，项目目录如下： 50 51 52 53在window环境下的，根据输入三方库项目,生成的输出文件result.xlsx，如下所示： 54 55 56 57其中生成的result.xlsx文件，风险接口如下所示： 58 59 60 61 62 63## 工具开发说明 64 65### 对象 66 67工具的开发者 68 69### 开发场景 70 71若当前工具的功能已经不能满足开发者的全部需求，则开发者可以基于已有的源码对工具进行二次开发，来增强工具的能力，编译打包生成自定义的可执行文件和插件。 72 73### 开发步骤 74 75开发者可以根据如下的步骤来完成对工具的开发： 76 77 [工具开发说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/api/docs/DEVELOP_ZH.md) 78 79## 版本说明 80 81暂无 82 83## FAQ 84 85 [FAQ](https://gitee.com/openharmony/napi_generator/tree/master/hdc/api/FAQ.md) 86 87## 参与贡献 88 89暂无 90 91## 相关仓 92 93暂无 94
