鸿蒙北向源码开发: 检查应用接口dts文件api规范性

开源鸿蒙5.0.2对应的api版本是14

5.0社区仓有工具检查接口规范性报告工具: interface/sdk-js/build-tools/api_check_plugin

api_check_plugin是什么?

在解释api_check_plugin是什么之前得先知道 应用调用的api接口都是文件名后缀为.d.ts的文件,这些文件内部声明了arkts的api,应用只需要从这些d.ts的文件中导入命名空间或着类,就可以在代码中使用相应的函数功能.

api的定义有着一定的规范

比如定义一个枚举,需要如下声明:

    /**

     * Enumerates  state.

     * @enum {number}

     * @syscap SystemCapability.XXXXX.XXXXX

     * @systemapi

     * @since 11

     */

比如定义一个接口,需要如下声明

    /**
     * Provides the device information definitions.
     * @interface DevInfo
     * @syscap SystemCapability.XXXX.XXXX
     * @systemapi
     * @since 11
     */

很多时候我们自己添加的d.ts虽然功能都能调通,但是d.ts文件却不满足api的声明规范,这时候可以用api_check_plugin工具来检查并纠错我们d.ts文件不规范的地方

api_check_plugin如何获取?

在开源鸿蒙的主干代码里面已经集成了这个仓,仓的相对路径为

interface/sdk-js/buil