[解決済み】ASP.NET Coreがステータスコード付きのJSONを返す

質問

.NET Core Web APIコントローラで、HTTPステータスコード付きのJSONを返す正しい方法を探しています。私はこのようにそれを使用しています。

public IHttpActionResult GetResourceData()
{
    return this.Content(HttpStatusCode.OK, new { response = "Hello"});
}

これは4.6のMVCアプリケーションにあったものですが、.NET Coreではこれがないようです。 IHttpActionResult 私は ActionResult で、このような使い方をしています。

public ActionResult IsAuthenticated()
{
    return Ok(Json("123"));
}

しかし、サーバーからの応答は、以下の画像のように変です。

Web APIコントローラは、Web API 2でやったように、HTTPステータスコード付きでJSONを返すようにしたいだけなんです。

どのように解決するのですか？

で応答する最も基本的なバージョンです。 JsonResult となります。

// GET: api/authors
[HttpGet]
public JsonResult Get()
{
    return Json(_authorRepository.List());
}

しかし、これはあなたの問題には役立ちません。なぜなら、あなた自身のレスポンス・コードを明示的に扱うことができないからです。

ステータスの結果を制御する方法ですが、これは ActionResult を利用することができます。 StatusCodeResult という型があります。

例えば

// GET: api/authors/search?namelike=foo
[HttpGet("Search")]
public IActionResult Search(string namelike)
{
    var result = _authorRepository.GetByNameSubstring(namelike);
    if (!result.Any())
    {
        return NotFound(namelike);
    }
    return Ok(result);
}

上記の2つの例は、Microsoft Documentationから入手できる素晴らしいガイドから得たものであることに注意してください。 レスポンスデータの書式設定

エクストラスタッフ

私がよく遭遇する問題は、VSの"New Project"テンプレートからデフォルトの構成で行くのではなく、WebAPIをより詳細に制御したいことです。

基本的なことを確認しておきましょう...。

ステップ1：サービスを設定する

ASP.NET Core WebAPI がステータス コードを完全に制御しながら JSON シリアライズ オブジェクトで応答するようにするには、最初に AddMvc() サービスを ConfigureServices メソッドは、通常 Startup.cs .

重要なのは AddMvc() は、他のリクエストタイプへの応答と同時に、JSON 用の Input/Output Formatter を自動的に含めます。

プロジェクトで フルコントロール を含む様々なリクエストタイプに対してWebAPIがどのように動作するかなど、サービスを厳密に定義したい場合。 application/json で、それ以外のリクエストタイプ（標準的なブラウザのリクエストなど）には応答しないようにするには、以下のコードで手動で定義します。

public void ConfigureServices(IServiceCollection services)
{
    // Build a customized MVC implementation, without using the default AddMvc(), instead use AddMvcCore().
    // https://github.com/aspnet/Mvc/blob/dev/src/Microsoft.AspNetCore.Mvc/MvcServiceCollectionExtensions.cs

    services
        .AddMvcCore(options =>
        {
            options.RequireHttpsPermanent = true; // does not affect api requests
            options.RespectBrowserAcceptHeader = true; // false by default
            //options.OutputFormatters.RemoveType<HttpNoContentOutputFormatter>();

            //remove these two below, but added so you know where to place them...
            options.OutputFormatters.Add(new YourCustomOutputFormatter()); 
            options.InputFormatters.Add(new YourCustomInputFormatter());
        })
        //.AddApiExplorer()
        //.AddAuthorization()
        .AddFormatterMappings()
        //.AddCacheTagHelper()
        //.AddDataAnnotations()
        //.AddCors()
        .AddJsonFormatters(); // JSON, or you can build your own custom one (above)
}

他のシリアライズ形式（protobuf、thriftなど）に対応するために、独自のカスタム入出力フォーマッタを追加する方法も含まれていることにお気づきでしょう。

上のコードの塊は、ほとんど AddMvc() メソッドを使用します。ただし、テンプレートであらかじめ用意されているサービスを利用するのではなく、各サービスを独自に定義して、quot;default"サービスを実装しています。コードブロックにリポジトリリンクを追加しました。 AddMvc() をGitHubのリポジトリからダウンロードします。 .

そもそも実装しないのではなく、デフォルトを元に戻すことで解決しようとするガイドもあることに注意してください...。私たちが今オープンソースで作業していることを考慮すると、これは冗長な作業であり、悪いコードであり、率直に言ってすぐに消えてしまう古い習慣です。

public class FooController
{
    [HttpPost]
    public async Task<IActionResult> Create([FromBody] Object item)
    {
        if (item == null) return BadRequest();

        var newItem = new Object(); // create the object to return
        if (newItem != null) return Ok(newItem);

        else return NotFound();
    }
}

options.RespectBrowserAcceptHeader = true; // false by default