Node.js / NestJS

Dokumentacja API i kontrakty

Swagger, OpenAPI, wersjonowanie, dokumentacja na wersję, Postman, kolekcje, kontrakty API

20 pytań z rozmów·
Junior
1

Czym jest Swagger w kontekście NestJS?

Odpowiedź

Swagger to narzędzie, które automatycznie generuje interaktywną dokumentację REST API poprzez analizę dekoratorów NestJS. Ta dokumentacja pozwala wizualizować i testować endpointy bezpośrednio z interfejsu webowego dostępnego pod adresem /api. Aby z niego korzystać, należy zainstalować pakiet @nestjs/swagger i skonfigurować SwaggerModule w main.ts.

2

Który pakiet należy zainstalować, aby używać Swaggera w NestJS?

Odpowiedź

Pakiet @nestjs/swagger to oficjalna biblioteka do integracji Swaggera z aplikacją NestJS. Należy również zainstalować swagger-ui-express, który zapewnia interaktywny interfejs webowy. Te dwa pakiety współpracują, aby wygenerować dokumentację OpenAPI i wyświetlić ją w przeglądarce.

3

Gdzie konfigurować SwaggerModule w aplikacji NestJS?

Odpowiedź

SwaggerModule konfiguruje się w pliku main.ts po utworzeniu aplikacji NestJS za pomocą NestFactory.create(). Metoda SwaggerModule.setup() przyjmuje trzy parametry: ścieżkę dokumentacji, instancję aplikacji oraz dokument wygenerowany przez createDocument(). Tę konfigurację należy wykonać przed app.listen(), aby dokumentacja była dostępna przy uruchomieniu.

4

Jaka jest rola dekoratora @ApiTags()?

5

Czym jest OpenAPI?

+17 pytań z rozmów

Opanuj Node.js / NestJS na następną rozmowę

Uzyskaj dostęp do wszystkich pytań, flashcards, testów technicznych, ćwiczeń code review i symulatorów rozmów.

Zacznij za darmo