Danet

La spécification OpenAPI est un format de définition indépendant du langage utilisé pour décrire les API RESTful. Danet fournit un module dédié qui permet de générer une telle spécification en utilisant des décorateurs.

DANGER

Le module SwaggerModule est actuellement en version alpha et de nombreuses fonctionnalités sont manquantes. Si quelque chose dont vous avez besoin n'est pas encore là, merci de remplir une demande de fonctionnalité ou un rapport d'erreur

Bootstrap

Ouvre simplement le fichier bootstrap.ts et initialise Swagger en utilisant la classe SwaggerModule :

import { DanetApplication } from 'jsr:@danet/core';
import { SwaggerModule, SpecBuilder } from 'jsr:@danet/swagger';
import { AppModule } from './app.module';

async function bootstrap() {
  const application = new DanetApplication();
  await application.init(AppModule);
  const spec = new SpecBuilder()
    .setTitle('Todo')
    .setDescription('The todo API')
    .setVersion('1.0')
    .build();
  const document = await SwaggerModule.createDocument(application, spec);
  SwaggerModule.setup('api', application, document);
  return application;
}

TIP

Le document (retourné par la méthode SwaggerModule#createDocument()) est un objet sérialisable conforme à OpenAPI Document. Au lieu de le diffuser via HTTP, vous pourriez également le sauvegarder sous forme de fichier JSON/YAML, et le consommer de différentes manières.

Le SpecBuilder aide à structurer un document de base conforme à la spécification OpenAPI. Il fournit plusieurs méthodes qui permettent de définir des propriétés telles que le titre, la description, la version, etc. Pour créer un document complet (avec toutes les routes HTTP définies), nous utilisons la méthode createDocument() de la classe SwaggerModule. Cette méthode prend deux arguments, une instance d'application et un objet d'options Swagger.

Une fois que nous avons créé un document, nous pouvons appeler la méthode setup(). Elle prend :

Le chemin d'accès pour monter l'interface utilisateur Swagger
Une instance d'application
L'objet document instancié ci-dessus

Maintenant, vous pouvez exécuter la commande suivante pour démarrer le serveur HTTP :

bash

$ deno task launch-server

Pendant que l'application est en cours d'exécution, ouvrez votre navigateur et accédez à http://localhost:3000/api. Vous devriez voir l'interface utilisateur Swagger.

Le SwaggerModule reflète automatiquement tous vos points d'extrémité.

TIP

Pour générer et télécharger un fichier JSON Swagger, accédez à http://localhost:3000/api/json (en supposant que votre documentation Swagger est disponible sous http://localhost:3000/api).

Bootstrap ​

Bootstrap