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.
Installation
Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.
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
Activate your virtual environment.
Install the required dependencies:
cd <repo_root>
pip install -e ./eng/tools/azure-sdk-tools
Instructions
Navigate to the desired package directory
Run the command:
azpysdk apistub .
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.
If the user explicitly asks for the raw APIView token file, run azpysdk apistub . --token-file instead.
