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
Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.
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.
