Node.js / NestJS

API-Dokumentation & Verträge

Swagger, OpenAPI, Versionierung, Dokumentation pro Version, Postman, Collections, API-Verträge

20 Interview-Fragen·
Junior
1

Was ist Swagger im Kontext von NestJS?

Antwort

Swagger ist ein Tool, das automatisch interaktive REST-API-Dokumentation generiert, indem es NestJS-Decorators analysiert. Diese Dokumentation ermöglicht es, Endpoints direkt über eine Weboberfläche zu visualisieren und zu testen, die über /api erreichbar ist. Die Installation des Pakets @nestjs/swagger und die Konfiguration von SwaggerModule in main.ts sind erforderlich, um es zu nutzen.

2

Welches Paket muss installiert werden, um Swagger in NestJS zu nutzen?

Antwort

Das Paket @nestjs/swagger ist die offizielle Bibliothek zur Integration von Swagger in eine NestJS-Anwendung. Außerdem muss swagger-ui-express installiert werden, das die interaktive Weboberfläche bereitstellt. Diese beiden Pakete arbeiten zusammen, um die OpenAPI-Dokumentation zu generieren und im Browser anzuzeigen.

3

Wo wird SwaggerModule in einer NestJS-Anwendung konfiguriert?

Antwort

SwaggerModule wird in der Datei main.ts konfiguriert, nachdem die NestJS-Anwendung mit NestFactory.create() erstellt wurde. Die Methode SwaggerModule.setup() nimmt drei Parameter entgegen: den Dokumentationspfad, die Anwendungsinstanz und das von createDocument() generierte Dokument. Diese Konfiguration muss vor app.listen() erfolgen, damit die Dokumentation beim Start zugänglich ist.

4

Welche Rolle hat der Decorator @ApiTags()?

5

Was ist OpenAPI?

+17 Interview-Fragen

Meistere Node.js / NestJS für dein nächstes Interview

Zugang zu allen Fragen, Flashcards, technischen Tests, Code-Review-Übungen und Interview-Simulatoren.

Kostenlos starten