La section info
💡 Sujet
La section info fournit les métadonnées essentielles sur l'API. C'est la première chose que les utilisateurs (et les générateurs de documentation) lisent pour comprendre l'objectif et la version de l'interface.
⚙️ Configuration
Voici les champs principaux de cet objet :
info:
title: API de Gestion de Stock
description: Cette API permet de gérer l'inventaire et les commandes.
version: 1.0.2
termsOfService: https://exemple.com/terms/
contact:
name: Support Technique
url: https://support.exemple.com
email: tech@exemple.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html🛠️ Détails des champs
- title (requis) : Le nom de votre API.
- version (requis) : La version de votre document d'API (souvent liée au versionnement sémantique).
- description : Supporte le format Markdown pour une documentation riche dès l'en-tête.
🧩 Résumé
- Identité : Définit qui fournit l'API et à quoi elle sert.
- Licence & Contact : Crucial pour les API publiques ou partagées entre équipes.
- Markdown : Profitez de la description pour donner des instructions générales.