C# と VB.NET の質問掲示板

Framework 4.8
VS2022
Win10
C# 11
-----
.Net Coreではなく、FrameworkのWeb APIです。
idは正しく取得できていますが、[FromBody]のValueがnullです。
Body部のjsonはStringで取得後、自前で逆シリアライズを行います。

※[FromBody] String valueではなく、GetTest value(または[FromBody] GetTest value)にした場合は成功しますが、stringで取得したいです。
※[FromBody] String valueではなく、dynamic valueの場合は成功しますが、略

-----調べたこと
下記一通り※英語が拙く、勘違いしている可能性あり
https://stackoverflow.com/questions/22741943/web-api-post-body-object-always-null

----- HTTP Header
POST /api/Test/hoge HTTP/1.1
Content-Length: 26
Content-Type: application/json
Host: localhost:54264
{"From": "123","To":"ABC"}

----- GetTest.cs
public class GetTest
{
    public string From { get; set; }
    public string To { get; set; }

    public GetTest()
    {

    }
}



-----TestController.cs
public class TestController : ApiController
{
    public string Post(string id, [FromBody] string value)
    {
        //var value = string.Empty;
        var Result = string.Empty;         <= break point
        string sCmd = id;
        string sId = string.Empty;
        string sKey = string.Empty;
        JsonSerializerOptions options = new JsonSerializerOptions
        {
            Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
            WriteIndented = false
        };
...

■No103235 (ded さん) に返信
> idは正しく取得できていますが、[FromBody]のValueがnullです。

application/x-www-form-urlencoded の Content-Type でリクエストしたら届きませんか?
cUrl コマンドで動作確認してみました。URL は適宜変更してください。


curl -X POST -d "id=abc&value=xyz" -include "http://localhost:43138/Test/Post"
⇒ id=="abc", value=="xyz"

curl -X POST -d "value=12345" -include "http://localhost:43138/Test/Post?id=56789"
⇒ id=="56789", value=="12345"

curl -X POST -d "id=bodyId&value=bodyValue" -include "http://localhost:43138/Test/Post?id=queryId"
⇒ id=="bodyId", value=="queryValue"

curl -X POST -d "value=%E9%AD%94%E7%95%8C%E3%81%AE%E4%BB%AE%E9%9D%A2%E5%BC%81%E5%A3%AB" -include "http://localhost:43138/Test/Post?id=112233"
⇒ id=="112233", value=="魔界の仮面弁士"

curl -X POST -d "id=test&value=%E9%AD%94%E7%95%8C%E3%81%AE%E4%BB%AE%E9%9D%A2%E5%BC%81%E5%A3%AB" -include "http://localhost:43138/Test/Post"
⇒ id=="test", value=="魔界の仮面弁士"

curl -X POST -d "id=body&value=%E9%AD%94%E7%95%8C%E3%81%AE%E4%BB%AE%E9%9D%A2%E5%BC%81%E5%A3%AB" -include "http://localhost:43138/Test/Post?id=uri"
⇒ id=="body", value=="魔界の仮面弁士"

curl -X POST --data-urlencode "id=body&value=魔界の仮面弁士" -include "http://localhost:43138/Test/Post"
⇒ id=="body&value=魔界の仮面弁士", value==null

curl -X POST --data-urlencode "id=body&value=%E9%AD%94%E7%95%8C%E3%81%AE%E4%BB%AE%E9%9D%A2%E5%BC%81%E5%A3%AB" -include "http://localhost:43138/Test/Post"
⇒ id=="body&value=%E9%AD%94%E7%95%8C%E3%81%AE%E4%BB%AE%E9%9D%A2%E5%BC%81%E5%A3%AB", value==null

WebSurfer さん、魔界の仮面弁士さん

ありがとうございました。

「Talend API Tester」と「curl」で無事に取得できるようになりました。

原因はWebSurfer さんの推察通り、formatterが適切ではなかった様です。
Content-Typeを「application/x-www-form-urlencoded」
Bodyを「={"From": "123","To":"ABC"}」
にする事で、期待通りの結果が返ってきました。


以下TT
-----Talend API Tester
METHOD：POST
URI:http://localhost:54264/api/Test/hoge
HEADRES:Content-Type:application/x-www-form-urlencoded
BODY:={"From": "123","To":"ABC"}

-----ヘッダ
POST /api/Test/hoge HTTP/1.1
Content-Length: 27
Content-Type: application/x-www-form-urlencoded
Host: localhost:54264
={"From": "123","To":"ABC"}

-----curl
url -X POST -H "Content-Type:application/x-www-form-urlencoded" -d "={\"From\": \"123\",\"To\":\"ABC\"}" -i http://localhost:54264/api/Test/hoge
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/json; charset=utf-8
Expires: -1
Server: Microsoft-IIS/10.0
X-AspNet-Version: 4.0.30319
X-SourceFiles: =<<念のためマスク>>
X-Powered-By: ASP.NET
Date: Tue, 09 Jul 2024 07:41:35 GMT
Content-Length: 33

<<念のためマスク>>

----- GetTest.cs
public class GetTest
{
    public string From { get; set; }
    public string To { get; set; }

    public GetTest() { }
}

-----コントローラ(一部)
/// <summary>Test コントローラー</summary>
public class TestController : ApiController
{
    public string Post(string id, [FromBody] string arg1)
    {
        var value = arg1.ToString();
        var Result = string.Empty;
        string sCmd = id;
        string sId = string.Empty;
        string sKey = string.Empty;
        JsonSerializerOptions options = new JsonSerializerOptions
        {
            Encoder = JavaScriptEncoder.Create(UnicodeRanges.All),
            WriteIndented = false
        };
...

■No103248 (ded さん) に返信

今更ながらですが・・・

先に紹介した MSDN Blog の記事、

How WebAPI does Parameter Binding
https://learn.microsoft.com/ja-jp/archive/blogs/jmstall/how-webapi-does-parameter-binding

の最初のコードにある HttpRequestMessage を引数に持つアクションメソッドで、引数から
HttpContent を取得し、HttpContent.ReadAsStringAsync メソッドでコンテンツを取得する
手段もあります。

具体的には例えば先に紹介した私のブログの記事、

ASP.NET Web API のバインディング
http://surferonwww.info/BlogEngine/post/2018/09/11/aspnet-web-api-parameter-binding.aspx

の Web API の Post アクションメソッド、

// POST api/values  (Create...レコード追加)
public List<Hero> Post(Hero postedHero)
{
    heroes.Add(postedHero);
    return heroes;
}

を以下のように変更して jsonString 変数にボディに含まれて送信されてきた JSON 文字
列を取得できます。それをデシリアライズして Add すれば上のコードと同じ結果が得ら
れます。

public async Task<List<Hero>> Post(HttpRequestMessage request)
{
    HttpContent content = request.Content;
    string jsonString = await content.ReadAsStringAsync();
    var postedHero = JsonConvert.DeserializeObject<Hero>(jsonString);
    heroes.Add(postedHero);
    return heroes;
}