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で見る