# API-Dokumentation & Verträge (Node.js / NestJS)

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

- 20 Interview-Fragen
- Junior
- [Interview-Fragen: Node.js / NestJS](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen.md)

## 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.

## 17 weitere Fragen verfügbar

- Welche Rolle hat der Decorator @ApiTags()?
- Was ist OpenAPI?

Kostenlos registrieren: https://sharpskill.dev/de/login

## Weitere Node.js / NestJS-Interviewthemen

- [Node.js-Grundlagen](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/nodejs-fundamentals.md): 20 Fragen, Junior
- [Node.js Core-APIs](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/nodejs-core-apis.md): 25 Fragen, Junior
- [Asynchrone Programmierung](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/asynchronous-programming.md): 25 Fragen, Junior
- [Express.js-Grundlagen](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/express-basics.md): 20 Fragen, Junior
- [NestJS-Grundlagen](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/nestjs-fundamentals.md): 23 Fragen, Junior
- [REST-API-Design](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/rest-api-design.md): 20 Fragen, Junior
- [Validierung & DTO](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/validation-dto.md): 20 Fragen, Junior
- [Fehlerbehandlung](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/error-handling.md): 20 Fragen, Junior
- [Unit-Testing](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/testing-unit.md): 20 Fragen, Junior
- [Aufgabenplanung](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/scheduling-cron.md): 15 Fragen, Junior
- [NestJS-Module & DI](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/nestjs-modules-di.md): 20 Fragen, Mid-Level
- [Konfiguration und Umgebungsverwaltung](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/configuration-environment.md): 20 Fragen, Mid-Level
- [JWT-Authentifizierung](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/authentication-jwt.md): 25 Fragen, Mid-Level
- [Autorisierung und RBAC](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/authorization-rbac.md): 20 Fragen, Mid-Level
- [Datenbank mit TypeORM](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/database-typeorm.md): 30 Fragen, Mid-Level
- [Prisma ORM](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/prisma-orm.md): 25 Fragen, Mid-Level
- [Middleware und Interceptors](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/middleware-interceptors.md): 20 Fragen, Mid-Level
- [Datei-Upload](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/file-upload.md): 15 Fragen, Mid-Level
- [WebSockets](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/websockets.md): 20 Fragen, Mid-Level
- [GraphQL mit NestJS](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/graphql-basics.md): 25 Fragen, Mid-Level
- [End-to-End-Tests](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/testing-e2e.md): 20 Fragen, Mid-Level
- [Caching mit Redis](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/caching-redis.md): 20 Fragen, Mid-Level
- [Warteschlangen mit Bull](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/queues-bull.md): 20 Fragen, Mid-Level
- [DevOps, Logging & CI/CD](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/logging-monitoring.md): 25 Fragen, Mid-Level
- [Docker und Containerisierung](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/docker-containerization.md): 25 Fragen, Mid-Level
- [Microservices](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/microservices.md): 30 Fragen, Senior
- [Best Practices für Sicherheit](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/security-best-practices.md): 25 Fragen, Senior
- [Performance und Cloud-Deployment](https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/performance-optimization.md): 30 Fragen, Senior

---

Source: SharpSkill (https://sharpskill.dev), tech interview preparation for your real stack.
HTML version of this page: https://sharpskill.dev/de/technologies/node-nestjs/interviewfragen/api-documentation