問題タブ [nestjs-swagger]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
1 に答える
300 参照

swagger - Nestjs の Swagger でスキーマ (dto) の説明を追加するにはどうすればよいですか?

説明フィールドを dto に追加したいのですが ( no_schema_descriptionOpenAPI linting で満たすためにも)、そうする方法が見つかりません。どのデコレータを使用しますか? dto を定義する時点で、または応答で?

更新 (明確化): 単一のプロパティではなく、スキーマ全体の説明を定義しようとしています。

0 投票する
0 に答える
86 参照

swagger - NestJs: swagger と class-transformer をマップされた型と組み合わせる

mapped-typesと を使用する方法はありますswaggerclass-transformer

ここで何がうまくいかないかの例を手に入れました: https://stackblitz.com/edit/nestjs-starter-demo-aq1sw2?file=src/dtos/user-descriptor.dto.ts

DTO:

ProjectDescriptorDto

ProjectDto

UserDescriptorDto

ユーザーDto

この例では、PickTypefromを使用@nestjs/mapped-typesしてコードをコンパイルしますが、拡張クラスの正しい swagger 仕様を生成しません。

Swagger 仕様を正しく生成するにはPickTypefromを使用する必要がありますが、パッケージのデコレーターと組み合わせると、コードは正しくコンパイルされません。@nestjs/swagger@Type()class-transform

問題は次のとおりです。これを回避する方法はありますか、mapped-typesまたは代わりに記述子を拡張しないでください。現在の回避策は、次を使用することです。

0 投票する
0 に答える
29 参照

nestjs-swagger - @nestjs/swagger を使用しようとしたときに、基本的な承認で Swagger UI 承認ボタンの js をカスタマイズまたは挿入する方法を教えてください。

件名として、nestjs/swagger を使用したプロジェクトがあります。以下のようにボタンをカスタマイズする方法を知っているかもしれません。swagger UI は、API を使用する前にユーザー名とパスワードで認証を試みていないからです。

swaggerUI

0 投票する
1 に答える
66 参照

nestjs - Nestjs swagger に特定のモジュールのみを含める方法

ユーザーモジュール(UserModule)、ドライバーモジュール(DriverModule)などのモジュールがいくつかあります。ドライバー モジュールの API だけをスワッガーで表示したい。

SwaggerModule.createDocumentSwaggerOption の 3 番目のパラメーターがあることはわかっています。

しかし、このように書いた後、SwaggerはAPIを表示していません. No operations defined in spec!UI で swagger からメッセージを受け取ります。私は自分が間違っていることを理解できません。