RicoSuter/NSwag

Exception occurring during c# client generation using any code generation method

Open

#2,885 opened on 2020年6月10日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedtype: bug

説明

While generating the c# client for an api an exception occurs. I isolated the smallest section of the API that fails and it can bee seen in the attached "sample-api.txt" file (json) The issue appears related to having an example node under the content type section (application/json) without having an schema node. That particular scenario is not flagged as an error is Swagger and the documentation does not point to schema being a mandatory node. sample-api.txt

コントリビューターガイド

技術スタック
csharp
領域
api
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
C# knowledgeUnderstanding of OpenAPINSwag basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
Investigate the NSwag code generation logic that handles example nodes in content types without a schema. Look in the NJsonSchema or codegen source for where the schema property is accessed and ensure it is null checked. Use the attached sample api.txt to reproduce the exception and identify the exact location. Consider adding a fallback or validation when schema is missing.