# APIドキュメントと契約 (Node.js / NestJS)

> Swagger、OpenAPI、バージョニング、バージョンごとのドキュメント、Postman、コレクション、API契約

- 20 面接問題
- Junior
- [面接問題: Node.js / NestJS](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions.md)

## 1. NestJSの文脈におけるSwaggerとは何ですか？

**回答**

Swaggerは、NestJSのデコレーターを解析して対話型のREST APIドキュメントを自動生成するツールです。このドキュメントでは、/apiからアクセスできるWebインターフェースから直接エンドポイントを視覚化してテストできます。利用するには、@nestjs/swaggerパッケージのインストールとmain.tsでのSwaggerModuleの設定が必要です。

## 2. NestJSでSwaggerを使うにはどのパッケージをインストールしますか？

**回答**

@nestjs/swaggerパッケージは、SwaggerをNestJSアプリケーションに統合するための公式ライブラリです。さらに、対話型のWebインターフェースを提供するswagger-ui-expressもインストールする必要があります。これら2つのパッケージが連携して、OpenAPIドキュメントを生成しブラウザに表示します。

## 3. NestJSアプリケーションでSwaggerModuleはどこで設定しますか？

**回答**

SwaggerModuleは、NestFactory.create()でNestJSアプリケーションを作成した後、main.tsファイル内で設定します。SwaggerModule.setup()メソッドは3つのパラメーター、すなわちドキュメントのパス、アプリケーションのインスタンス、createDocument()で生成されたドキュメントを受け取ります。この設定は、起動時にドキュメントへアクセスできるよう、app.listen()の前に行う必要があります。

## さらに17問利用可能

- @ApiTags()デコレーターの役割は何ですか？
- OpenAPIとは何ですか？

無料で登録: https://sharpskill.dev/ja/login

## その他のNode.js / NestJS面接トピック

- [Node.js の基礎](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/nodejs-fundamentals.md): 20問, Junior
- [Node.js コア API](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/nodejs-core-apis.md): 25問, Junior
- [非同期プログラミング](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/asynchronous-programming.md): 25問, Junior
- [Express.js の基礎](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/express-basics.md): 20問, Junior
- [NestJSの基礎](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/nestjs-fundamentals.md): 23問, Junior
- [REST API 設計](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/rest-api-design.md): 20問, Junior
- [バリデーションとDTO](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/validation-dto.md): 20問, Junior
- [エラーハンドリング](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/error-handling.md): 20問, Junior
- [ユニットテスト](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/testing-unit.md): 20問, Junior
- [タスクスケジューリング](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/scheduling-cron.md): 15問, Junior
- [NestJS のモジュールと DI](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/nestjs-modules-di.md): 20問, Mid-Level
- [設定と環境管理](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/configuration-environment.md): 20問, Mid-Level
- [JWT認証](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/authentication-jwt.md): 25問, Mid-Level
- [認可とRBAC](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/authorization-rbac.md): 20問, Mid-Level
- [TypeORMによるデータベース](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/database-typeorm.md): 30問, Mid-Level
- [Prisma ORM](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/prisma-orm.md): 25問, Mid-Level
- [ミドルウェアとインターセプター](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/middleware-interceptors.md): 20問, Mid-Level
- [ファイルアップロード](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/file-upload.md): 15問, Mid-Level
- [WebSockets](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/websockets.md): 20問, Mid-Level
- [NestJSによるGraphQL](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/graphql-basics.md): 25問, Mid-Level
- [エンドツーエンドテスト](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/testing-e2e.md): 20問, Mid-Level
- [Redisによるキャッシング](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/caching-redis.md): 20問, Mid-Level
- [Bull によるキュー](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/queues-bull.md): 20問, Mid-Level
- [DevOps、Logging、CI/CD](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/logging-monitoring.md): 25問, Mid-Level
- [Docker とコンテナ化](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/docker-containerization.md): 25問, Mid-Level
- [マイクロサービス](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/microservices.md): 30問, Senior
- [セキュリティのベストプラクティス](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/security-best-practices.md): 25問, Senior
- [パフォーマンスとクラウドデプロイ](https://sharpskill.dev/ja/technologies/node-nestjs/interview-questions/performance-optimization.md): 30問, Senior

---

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