(Ajax)Postでdataを送っていますが、サーバーのコントローラーで受け取ることができない

Question

環境

.Core3.1　
C#

現象

Ajax の Post でクライアントからJsonデータを送り、サーバー側のWebAPIコントローラーでそのJsonデータを受け取りたいのですが、データがnullになって困っています。

同様の質問を確認して試行錯誤しているのですが成功しないため、どなたかお知恵をお借りしたいです。

クライアントからの送信データ

{ str : "ABC" }

下記にあるようにプログラムし、
Getメソッドでは、サーバー側で値の取得に成功しましたが、
Postメソッドでは、サーバー側メソッドの引数がnullになってしまいます。

ためしたプログラム（サーバー側）

[Route("api/Test")]
[ApiController]
public class TestController : ControllerBase
{
    [HttpGet("get1")]
    public string GetData([FromQuery] string str)
    {
        Debug.WriteLine(str);
        return "";
    }

    [HttpPost("post1")]
    public void PostData(string str)
    {
        Debug.WriteLine(str);
    }
}

ためしたプログラム（クライアント側）

/* テスト用Getメソッド */
function button_get_click() {
    var pUrl = "/api/Test/get1";

    $.ajax({
        type: "GET",
        url: pUrl,
        cache: false,
        dataType: "json",
        data: { str : "ABC" },
        async: false,
        success: function (data) {
            console.log("success");
        }
    });
};

/* テスト用Postメソッド */
function button_post_click() {
    var pUrl = "/api/Test/post1";

    $.ajax({
        type: "POST",
        url: pUrl,
        cache: false,
        contentType: 'application/json',
        dataType: "json",
        data: JSON.stringify({ str: "ABC" }),
        //data: { str: "ABC" } ←これでもやはりnullでした
        async: false,
        success: function (data) {
            console.log("success");
        }
    });
};

◆Postもサーバー側には到達しているのですが、引数がnullになってしまいます。

◆ブラウザ(Edge)でF12を押し、ネットワークの要求本文には「{"str":"ABC"}」が設定されていることを確認しました。

よろしくお願いいたします。

Comments

[退会済みユーザー]

ASP.NET の話であれば ASP.NET のタグをつけてください。

[ryu_k]

ありがとうございます。タグをつけました。

Answer 1

自分が試した限りですが、Core 版では以下の記事のようにコンプレックス型をアクションメソッドの引数に渡さないとダメでした。

ASP.NET Core 3.1 Web API
http://surferonwww.info/BlogEngine/post/2020/05/15/aspnet-core-3-web-api.aspx

ちなみに上の記事でコンプレックス型というのは以下のような Hero クラスのことです。

namespace WebAPI.Models
{
    public class Hero
    {
        public int Id { get; set; }
        public string Name { get; set; }
    }
}

コンプレックス型を定義して渡してみてください。

Core 版も同じかどうか不明ですが、.NET Framework 版の Web API では string などのプリミティブ型をアクションメソッドの引数にした場合、引数に属性が付与されてなければクエリ文字列からパラメータを探してモデルバインディングします。

属性を付与して、

[FromBody] string name

・・・のようにすればボディから探しますが、その場合でも jQuery ajax の data に "name=value" と設定してはダメで、"=value" としないと引数 name にはバインドされません。わけが分からないのですが、何にせよそういうウラワザ的なことは避けた方がよさそうです。

Comments

[ryu_k]

実現できました！

ご教示いただいたとおりに、クラスを定義し値が設定されることが確認できました。

コンプレックス型、理解できました！
とても助かりました。ありがとうございます！