Synthèse automatique
Détecte le type de spécification API (OpenAPI, Swagger, GraphQL, AsyncAPI, Protobuf), la valide, puis génère l'arborescence de documentation MDX et la configuration docs.json correspondante.
Points forts
- Reconnaît cinq formats de spécification et applique le traitement approprié à chacun
- Vérifie la syntaxe, la résolution des $ref, les schémas d'authentification et les URLs de serveur avant génération
- Produit une structure de fichiers cohérente (introduction, authentification, erreurs) et met à jour l'onglet dans docs.json
- Sépare explicitement les pages queries, mutations et subscriptions pour GraphQL
Limites
- Suppose une documentation de type Mintlify reposant sur docs.json et des fichiers .mdx
- Les pages générées restent des squelettes remplis à partir des champs de la spec, pas des guides rédigés
- La page rate-limiting n'est créée que si l'extension x-rateLimit est présente dans la spec
À utiliser lorsqu'on dispose d'une spec OpenAPI, GraphQL ou AsyncAPI et qu'il faut amorcer rapidement une section de référence API dans un site de documentation.
À éviter si le site de documentation n'utilise ni docs.json ni MDX, ou s'il faut rédiger des guides conceptuels sur mesure plutôt que des pages dérivées de la spec.
Analyse de sécurité
SûrThe skill consists entirely of documentation and file-generation instructions (detecting spec types, validating schemas, laying out api-reference directories, updating docs.json, and emitting MDX templates). It declares no tools, invokes no shell/curl/network operations, does not read or transmit secrets, and contains no destructive or obfuscated actions. There is no meaningful execution risk in listing it.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
Import api/openapi.yaml, generate the API reference docs including authentication and errors pages, and add the tab to docs.json.Add schema.graphql to our docs as a GraphQL API tab with separate queries, mutations and subscriptions pages.Check asyncapi.yaml for $ref resolution issues and auth schemes, then scaffold the AsyncAPI documentation under api-reference/.name: import-api-spec description: Import and configure API specification (OpenAPI, GraphQL, AsyncAPI) for documentation
Instructions
When importing an API specification:
Step 1: Detect Spec Type
| File Pattern | Type | Version |
|--------------|------|---------|
| openapi.json/yaml | OpenAPI | 3.x |
| swagger.json/yaml | Swagger | 2.0 |
| schema.graphql | GraphQL | - |
| asyncapi.json/yaml | AsyncAPI | 2.x/3.x |
| *.proto | Protobuf/gRPC | - |
Step 2: Validate & Process
- Validate spec syntax
- Check for $ref resolution issues
- Identify auth schemes
- Extract server URLs
Step 3: Generate Documentation
For OpenAPI/Swagger:
api-reference/
├── openapi.json # Cleaned/validated spec
├── introduction.mdx # API overview from info
├── authentication.mdx # From securitySchemes
├── errors.mdx # From error response schemas
└── rate-limiting.mdx # If x-rateLimit extension exists
For GraphQL:
api-reference/
├── schema.graphql # Schema file
├── introduction.mdx # Overview
├── authentication.mdx # Auth guide
├── queries.mdx # Query documentation
├── mutations.mdx # Mutation documentation
└── subscriptions.mdx # If subscriptions exist
Step 4: Update docs.json
Add appropriate tab configuration:
// OpenAPI
{
"tab": "API Reference",
"type": "openapi",
"path": "/api-reference",
"spec": "api-reference/openapi.json",
"groups": [
{
"group": "Overview",
"pages": [
"api-reference/introduction",
"api-reference/authentication"
]
}
]
}
// GraphQL
{
"tab": "GraphQL API",
"type": "graphql",
"path": "/graphql-api",
"schema": "api-reference/schema.graphql",
"endpoint": "https://api.example.com/graphql"
}
Step 5: Generate Supporting Pages
introduction.mdx
---
title: "API Introduction"
description: "Overview of the {API Name}"
---
{Description from spec info}
## Base URL
Production: `{server URL}`
## Authentication
{Summary of auth methods}
See [Authentication](/api-reference/authentication) for details.
authentication.mdx
---
title: "Authentication"
description: "How to authenticate API requests"
---
{Content based on securitySchemes}
Du fichier au premier essai
Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.
Consulter la source et ses fichiers annexesCe téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.
1. Télécharger le fichier
Télécharger SKILL.mdDepuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/import-api-specification-mmio721h/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.
Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.
mkdir -p '.skill-downloads/import-api-specification-mmio721h' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/import-api-specification-mmio721h/download' --output '.skill-downloads/import-api-specification-mmio721h/SKILL.md.part' && mv '.skill-downloads/import-api-specification-mmio721h/SKILL.md.part' '.skill-downloads/import-api-specification-mmio721h/SKILL.md'2. Vérifier les prérequis
Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.
Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.
Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.
3. Charger la skill
Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.
Claude Code
test -f '.skill-downloads/import-api-specification-mmio721h/SKILL.md' && test -s '.skill-downloads/import-api-specification-mmio721h/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/import-api-spec' && cp -R '.skill-downloads/import-api-specification-mmio721h' '.claude/skills/import-api-spec'Cursor
test -f '.skill-downloads/import-api-specification-mmio721h/SKILL.md' && test -s '.skill-downloads/import-api-specification-mmio721h/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/import-api-spec' && cp -R '.skill-downloads/import-api-specification-mmio721h' '.cursor/skills/import-api-spec'Codex
test -f '.skill-downloads/import-api-specification-mmio721h/SKILL.md' && test -s '.skill-downloads/import-api-specification-mmio721h/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/import-api-spec' && cp -R '.skill-downloads/import-api-specification-mmio721h' '.agents/skills/import-api-spec'OpenSkills
OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.
Installation officielle d’OpenSkillsopenskills install './.skill-downloads/import-api-specification-mmio721h'openskills read 'import-api-specification-mmio721h'La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.
Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.
openskills syncMode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.
4. Faire un premier essai
Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :
Lis .skill-downloads/import-api-specification-mmio721h/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.
Rédaction de docs Supabase
Documentation
Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.
Créer un enregistrement de décision d'architecture
Documentation
Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.
Mise à jour de plan avec recherche approfondie
Documentation
Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.