RicoSuter/NSwag

Consider using JSON convertion for path and query parameters

Open

#675 opened on 2017年3月14日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration.WebApitype: bug

説明

When an enum value is passed in the path or query, the EnumMemberAttribute is ignored because the value is serialized with ToString().

public enum Operation
{
    [EnumMember("set")]
    Set,
    [EnumMember("update")]
    Update,
}

public enum Value
{
    [EnumMember("one")]
    First,
    [EnumMember("two")]
    Second,
}

public async Task DoAsync(Operation operation, Value value)
{
    // path = {operation}
    // value is a query parameter
}

Called with DoAsync(Operation.Set, Value.First) will result in the Set?First URL instead of set?one.

It would be great if the JSON serializer was used to serialize values to path and query.

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

技術スタック
csharptypescript
領域
backendapideveloper experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
C#NSwag basicsJSON serializationEnumMemberAttribute
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
Examine the NSwag source code to understand how path and query parameters are serialized currently. Focus on files that handle parameter conversion (e.g., in the NJsonSchema or NSwag core libraries). The issue indicates that EnumMemberAttribute is ignored; investigate why ToString() is used and how to integrate JSON serialization. Review the 5 comments for any additional context or suggested approaches.
Consider using JSON convertion for path and query parameters · RicoSuter/NSwag#675 | Good First Issue