API存根生成器

Azure SDK API审查工具用于审查所有发布的Azure SDK API，该审查工具适用于所有语言格式。API工具需要生成json格式的存根文件和令牌以在审查工具中列出API。API存根生成器包用于创建包含API表面层信息的存根文件。以下是在存根文件中包含的主要已发布组件。

- Classes and module level functions
- Instance methods
- Class and Instance variables
- Properties

创建API审查的步骤

以下是为Python包创建API审查请求的步骤。

1. 生成存根文件令牌
2. 将存根文件令牌上传到API审查门户

生成存根文件

使用apiview-stub-generator包可以从源代码仓库或预构建的wheel包中生成存根文件令牌。以下为生成存根文件令牌的步骤。

安装apiview-stub-generator包。从apiview-stub-generator包的根目录运行

pip install . --extra-index-url="https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-python/pypi/simple/"

使用源代码仓库或whl包作为参数运行apistubgen命令，这将生成包含令牌的json文件。

apistubgen的帮助

apistubgen --pkg-path <path to package root>

这还接受一个可选参数来指定json令牌文件将生成的输出路径。如果没有给出输出路径，则文件将在当前工作目录中生成。

apistubgen --pkg-path <path to package root> --out-path <Outpath path>

示例

apistubgen --pkg-path C:\git\azure-sdk-for-python\sdk\core\azure-core
apistubgen --pkg-path C:\git\azure-sdk-for-python\sdk\core\azure-core --out-path C:\out

将使用命名约定 `_python.json' 创建令牌文件

将令牌文件上传到API审查门户

• 访问 https://apiview.dev
• 点击 创建审查
• 选择生成的令牌文件并上传