adonisjs-swagger v1.1.0

AdonisJS Swagger

Intégration de Swagger dans vos projets AdonisJS 6 pour générer et afficher facilement la documentation de votre API.

Introduction

AdonisJS Swagger est un package qui facilite l'intégration de Swagger dans une application AdonisJS 6. Il s'appuie sur swagger-ui-express et swagger-jsdoc pour générer et servir la documentation Swagger.
Ce package est conçu pour être auto-contenu et simple à intégrer via un provider AdonisJS.

Caractéristiques

• Documentation API : Génération automatique de la documentation Swagger à partir de vos commentaires JSDoc.
• Provider intégré : Un provider AdonisJS qui configure automatiquement Swagger lors du démarrage de l'application.
• TypeScript supporté : Définitions de types fournies pour une meilleure intégration dans les projets TypeScript.
• Facilité d'installation : Utilisable via npm ou yarn, avec possibilité de tester localement grâce à npm link.

Installation

Installez le package via npm ou yarn :

npm install adonisjs-swagger
# ou
yarn add adonisjs-swagger