Swagger / OpenAPI

NestJS 🟡 Mid

Type : NestJS API

Definition

Integration automatique de la documentation API interactive. Les decorateurs NestJS generent le schema OpenAPI et une UI testable.

Analogie

Comme un menu de restaurant avec description et photos de chaque plat.

Exemple de code

const config = new DocumentBuilder()
  .setTitle(class="str">&#39;Mon API&#39;)
  .setVersion(class="str">&#39;1.0&#39;)
  .addBearerAuth()
  .build();
SwaggerModule.setup(class="str">&#39;api&#39;, app, SwaggerModule.createDocument(app, config));