generate-api-markdown
Generate an API markdown file and token file using ApiView. Use this when the user wants to generate an API markdown file and review API changes.
来源信息
- 仓库
- Azure/azure-sdk-for-python
- 最近来源活动
- 2026年6月19日 16:03
- 检测到的 SKILL.md 语言
- 英语
- 星标
- 5,587
- 分支
- 3,348
安装方式
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
检查来源文件
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
正在显示 SKILL.md
SKILL.md
来源说明 · 只读预览- name
- generate-api-markdown
- description
- Generate an API markdown file and token file using ApiView. Use this when the user wants to generate an API markdown file and review API changes.
# Generate API Markdown
## Prerequisites
1. Activate your virtual environment.
2. Install the required dependencies:
```bash
cd <repo_root>
pip install -e ./eng/tools/azure-sdk-tools
```
## Instructions
1. Navigate to the desired package directory
2. Run the command:
```bash
azpysdk apistub .
```
3. The command generates `api.md` and `api.metadata.yml` in the package directory, which are the files needed to pass the API consistency check. Provide these files to the user for review.
4. If the user explicitly asks for the raw APIView token file, run `azpysdk apistub . --token-file` instead.
在 GitHub 查看