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を返すだけです。

a 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);
}

上記の例は両方とも、Microsoftのドキュメントから入手できる優れたガイドに基づいています：応答データのフォーマット

余分なもの

私が頻繁に遭遇する問題は、VSの「新規プロジェクト」テンプレートからのデフォルト構成をそのまま使用するのではなく、WebAPIをより詳細に制御したいということです。

いくつかの基本事項を確認してみましょう...

ステップ1：サービスを構成する

ASP.NET Core WebAPIがステータスコードのフルコントロールに沿ってJSONシリアル化オブジェクトで応答できるようにするには、通常にあるメソッドにAddMvc()サービスが含まれていることを確認することから始めます。ConfigureServicesStartup.cs

にAddMvc()は、他のリクエストタイプへの応答とともに、JSONの入出力フォーマッタが自動的に含まれることに注意することが重要です。

プロジェクトがフルコントロールを必要とし、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()メソッドの複製です。ただし、事前に出荷されたテンプレートを使用するのではなく、すべてのサービスを定義することにより、各「デフォルト」サービスを独自に実装しています。コードブロックにリポジトリリンクを追加しました。またはAddMvc() 、GitHubリポジトリからチェックアウトできます。。

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

ステップ2：コントローラーを作成する

あなたの質問を分類するために、本当に簡単なものを紹介します。

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();
    }
}

ステップ3：あなたContent-TypeとAccept

リクエストのContent-TypeおよびAcceptヘッダーが正しく設定されていることを確認する必要があります。あなたのケース（JSON）では、に設定する必要があります。application/json

WebAPIがデフォルトでJSONとして応答するようにしたい場合は、要求ヘッダーが何を指定しているかに関係なく、いくつかの方法で行うことができます。

方法1 先に推奨した記事（応答データのフォーマット）で示したように、コントローラー/アクションレベルで特定のフォーマットを強制できます。私は個人的にはこのアプローチが好きではありません...しかし、ここでは完全性のためです：

特定の形式を強制する特定のアクションの応答形式を制限したい場合は、[Produces]フィルターを適用できます。[Produces]フィルターは、特定のアクション（またはコントローラー）の応答形式を指定します。ほとんどのフィルターと同様に、これはアクション、コントローラー、またはグローバルスコープで適用できます。

[Produces("application/json")]
public class AuthorsController

[Produces]フィルタ内のすべてのアクションを強制的に AuthorsController他のフォーマッタは、アプリケーションのために構成され、クライアントは、提供された場合であっても、JSON形式の応答を返すようにAccept異なる、利用可能なフォーマットを要求ヘッダー。

方法2 私が推奨する方法は、WebAPIが要求されたフォーマットですべての要求に応答することです。ただし、要求された形式を受け入れない場合は、デフォルト（JSONなど）にフォールバックします。

最初に、それをオプションに登録する必要があります（前述のように、デフォルトの動作をやり直す必要があります）。

options.RespectBrowserAcceptHeader = true; // false by default

最後に、サービスビルダーで定義されたフォーマッターのリストを並べ替えるだけで、Webホストはデフォルトでリストの一番上（つまり、位置0）に配置するフォーマッターになります。

詳細については、この.NET Web開発とツールのブログエントリをご覧ください。

最も一般的なステータスコードの定義済みメソッドがあります。

• Ok(result)200応答を返します
• CreatedAtRoute201+新しいリソースURLを返します
• NotFound 戻り値 404
• BadRequest返品400等

すべてのメソッドのリストについてはBaseController.cs、とController.csを参照してください。

ただし、実際にStatusCodeカスタムコードの設定に使用できると主張する場合は、コードの可読性が低下し、ヘッダーを設定するためにコードを繰り返す必要があるため（のようにCreatedAtRoute）、実際には使用しないでください。

public ActionResult IsAuthenticated()
{
    return StatusCode(200, "123");
}

ASP.NETコア2.0からオブジェクトを返すために理想的な方法Web API（MVCと一体と同じ基本クラスを使用しているController）であります

public IActionResult Get()
{
    return new OkObjectResult(new Item { Id = 123, Name = "Hero" });
}

そのことに注意してください

1. 200 OKステータスコードを返します（これはのOkタイプですObjectResult）
2. コンテンツのネゴシエーションを行います。つまりAccept、リクエストのヘッダーに基づいて戻ります。Accept: application/xmlリクエストで送信された場合、として返されXMLます。何も送信されない場合は、JSONデフォルトです。

特定のステータスコードで送信する必要がある場合は、ObjectResultまたはをStatusCode使用してください。どちらも同じことを行い、コンテンツネゴシエーションをサポートします。

return new ObjectResult(new Item { Id = 123, Name = "Hero" }) { StatusCode = 200 };
return StatusCode( 200, new Item { Id = 123, Name = "Hero" });

またはObjectResultでさらに細かく：

 Microsoft.AspNetCore.Mvc.Formatters.MediaTypeCollection myContentTypes = new Microsoft.AspNetCore.Mvc.Formatters.MediaTypeCollection { System.Net.Mime.MediaTypeNames.Application.Json };
 String hardCodedJson = "{\"Id\":\"123\",\"DateOfRegistration\":\"2012-10-21T00:00:00+05:30\",\"Status\":0}";
 return new ObjectResult(hardCodedJson) { StatusCode = 200, ContentTypes = myContentTypes };

特にJSONとして返したい場合は、いくつかの方法があります

//GET http://example.com/api/test/asjson
[HttpGet("AsJson")]
public JsonResult GetAsJson()
{
    return Json(new Item { Id = 123, Name = "Hero" });
}

//GET http://example.com/api/test/withproduces
[HttpGet("WithProduces")]
[Produces("application/json")]
public Item GetWithProduces()
{
    return new Item { Id = 123, Name = "Hero" };
}

そのことに注意してください

1. どちらもJSON2つの異なる方法で適用されます。
2. どちらもコンテンツのネゴシエーションを無視します。
3. 最初の方法は、特定のシリアライザーでJSONを適用しますJson(object)。
4. 第二の方法は、使用して同じことをProduces()（ある属性をResultFilter持ちます）contentType = application/json

それらの詳細については、公式ドキュメントをご覧ください。フィルターについては、こちらをご覧ください。

サンプルで使用される単純なモデルクラス

public class Item
{
    public int Id { get; set; }
    public string Name { get; set; }
}

私が思いついた最も簡単な方法は：

var result = new Item { Id = 123, Name = "Hero" };

return new JsonResult(result)
{
    StatusCode = StatusCodes.Status201Created // Status code here 
};

これは私の最も簡単な解決策です：

public IActionResult InfoTag()
{
    return Ok(new {name = "Fabio", age = 42, gender = "M"});
}

または

public IActionResult InfoTag()
{
    return Json(new {name = "Fabio", age = 42, gender = "M"});
}

列挙型を使用して404/201ステータスコードを使用する代わり

     public async Task<IActionResult> Login(string email, string password)
    {
        if (string.IsNullOrWhiteSpace(email) || string.IsNullOrWhiteSpace(password))
        { 
            return StatusCode((int)HttpStatusCode.BadRequest, Json("email or password is null")); 
        }

        var user = await _userManager.FindByEmailAsync(email);
        if (user == null)
        {
            return StatusCode((int)HttpStatusCode.BadRequest, Json("Invalid Login and/or password"));

        }
        var passwordSignInResult = await _signInManager.PasswordSignInAsync(user, password, isPersistent: true, lockoutOnFailure: false);
        if (!passwordSignInResult.Succeeded)
        {
            return StatusCode((int)HttpStatusCode.BadRequest, Json("Invalid Login and/or password"));
        }
        return StatusCode((int)HttpStatusCode.OK, Json("Sucess !!!"));
    }

私がここで見つけた素晴らしい答えと私はまた、このリターンステートメントを試してみましたが、StatusCode(whatever code you wish)うまくいきました!!!

return Ok(new {
                    Token = new JwtSecurityTokenHandler().WriteToken(token),
                    Expiration = token.ValidTo,
                    username = user.FullName,
                    StatusCode = StatusCode(200)
                });

以下のコードを参照してください。異なるタイプのJSONで複数のステータスコードを管理できます

public async Task<HttpResponseMessage> GetAsync()
{
    try
    {
        using (var entities = new DbEntities())
        {
            var resourceModelList = entities.Resources.Select(r=> new ResourceModel{Build Your Resource Model}).ToList();

            if (resourceModelList.Count == 0)
            {
                return this.Request.CreateResponse<string>(HttpStatusCode.NotFound, "No resources found.");
            }

            return this.Request.CreateResponse<List<ResourceModel>>(HttpStatusCode.OK, resourceModelList, "application/json");
        }
    }
    catch (Exception ex)
    {
        return this.Request.CreateResponse<string>(HttpStatusCode.InternalServerError, "Something went wrong.");
    }
}

私のAsp Net Core Apiアプリケーションで行うことは、ObjectResultから拡張するクラスを作成し、コンテンツとステータスコードをカスタマイズするための多くのコンストラクターを提供することです。次に、すべてのコントローラーアクションは、適切なものとしてcostructorの1つを使用します。あなたは私の実装をhttps://github.com/melardev/AspNetCoreApiPaginatedCrudで見ることができ ます

そして

https://github.com/melardev/ApiAspCoreEcommerce

これはクラスがどのように見えるかです（完全なコードについては私のリポジトリに移動してください）：

public class StatusCodeAndDtoWrapper : ObjectResult
{



    public StatusCodeAndDtoWrapper(AppResponse dto, int statusCode = 200) : base(dto)
    {
        StatusCode = statusCode;
    }

    private StatusCodeAndDtoWrapper(AppResponse dto, int statusCode, string message) : base(dto)
    {
        StatusCode = statusCode;
        if (dto.FullMessages == null)
            dto.FullMessages = new List<string>(1);
        dto.FullMessages.Add(message);
    }

    private StatusCodeAndDtoWrapper(AppResponse dto, int statusCode, ICollection<string> messages) : base(dto)
    {
        StatusCode = statusCode;
        dto.FullMessages = messages;
    }
}

base（dto）をdtoをオブジェクトに置き換えると、問題なく終了するはずです。

これでうまくいきました。私の大きな問題は、jsonが文字列であることでした（データベース内では、特定/既知のタイプではありませんでした）。

はい、ようやくこれを機能させました。

////[Route("api/[controller]")]
////[ApiController]
////public class MyController: Microsoft.AspNetCore.Mvc.ControllerBase
////{
                    //// public IActionResult MyMethod(string myParam) {

                    string hardCodedJson = "{}";
                    int hardCodedStatusCode = 200;

                    Newtonsoft.Json.Linq.JObject job = Newtonsoft.Json.Linq.JObject.Parse(hardCodedJson);
                    /* "this" comes from your class being a subclass of Microsoft.AspNetCore.Mvc.ControllerBase */
                    Microsoft.AspNetCore.Mvc.ContentResult contRes = this.Content(job.ToString());
                    contRes.StatusCode = hardCodedStatusCode;

                    return contRes;

                    //// } ////end MyMethod
              //// } ////end class

私はたまたまasp.netコア3.1を使用しています

#region Assembly Microsoft.AspNetCore.Mvc.Core, Version=3.1.0.0, Culture=neutral, PublicKeyToken=adb9793829ddae60
//C:\Program Files\dotnet\packs\Microsoft.AspNetCore.App.Ref\3.1.0\ref\netcoreapp3.1\Microsoft.AspNetCore.Mvc.Core.dll

ここからヒントを得た:: https://www.jianshu.com/p/7b3e92c42b61