#Documentation API

#Introduction

Ce plugin génère la documentation de l'API HTTP de NocoBase en se basant sur Swagger.

#Installation

C'est un plugin intégré, aucune installation n'est requise. Il vous suffit de l'activer pour l'utiliser.

#Instructions d'utilisation

#Accéder à la page de documentation de l'API

http://localhost:13000/admin/settings/api-doc/documentation

#Aperçu de la documentation

• Documentation API complète : /api/swagger:get
• Documentation de l'API du cœur (core) : /api/swagger:get?ns=core
• Documentation API de tous les plugins : /api/swagger:get?ns=plugins
• Documentation de chaque plugin : /api/swagger:get?ns=plugins/{name}
• Documentation API pour les collections personnalisées : /api/swagger:get?ns=collections
• Ressources spécifiques pour une ${collection} et ses associations ${collection}.${association} : /api/swagger:get?ns=collections/{name}

#Guide du développeur

#Comment rédiger la documentation Swagger pour les plugins

Ajoutez un fichier swagger/index.ts dans le dossier src de votre plugin, avec le contenu suivant :

export default {
  info: {
    title: 'NocoBase API - Auth plugin',
  },
  tags: [],
  paths: {},
  components: {
    schemas: {},
  },
};

Pour les règles de rédaction détaillées, veuillez consulter la documentation officielle de Swagger.