ASP.NET Core ส่งคืน JSON พร้อมรหัสสถานะ

ฉันกำลังมองหาวิธีที่ถูกต้องในการส่งคืน JSON ด้วยรหัสสถานะ HTTP ใน. NET Core Web API controller ของฉัน ฉันใช้มันแบบนี้:

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 ส่งคืน JSON ด้วยรหัสสถานะ HTTP เหมือนที่ฉันทำใน Web API 2

รุ่นพื้นฐานที่สุดที่ตอบสนองด้วย 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: การจัดรูปแบบข้อมูลการตอบสนอง

สิ่งพิเศษ

ปัญหาที่ฉันเจอบ่อยๆคือฉันต้องการการควบคุม WebAPI ที่ละเอียดยิ่งขึ้นแทนที่จะไปกับการกำหนดค่าเริ่มต้นจากแม่แบบ "โครงการใหม่" ใน VS

มาทำให้แน่ใจว่าคุณมีพื้นฐานบางอย่างอยู่ ...

ขั้นตอนที่ 1: กำหนดค่าบริการของคุณ

เพื่อให้ ASP.NET Core WebAPI ของคุณตอบสนองกับ JSON Serialized Object พร้อมการควบคุมรหัสสถานะอย่างสมบูรณ์คุณควรเริ่มต้นด้วยการทำให้แน่ใจว่าคุณได้รวมAddMvc()บริการในConfigureServicesวิธีการของคุณตามปกติStartup.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 .

โปรดทราบว่ามีคำแนะนำบางอย่างที่จะพยายามแก้ปัญหานี้โดย "เลิกทำ" ค่าเริ่มต้นแทนที่จะไม่นำมาใช้ในตอนแรก ... หากคุณพิจารณาว่าตอนนี้เรากำลังทำงานกับ Open Source นี่เป็นงานซ้ำซ้อน รหัสไม่ดีและนิสัยเก่าตรงไปตรงมาที่จะหายไปในไม่ช้า

ขั้นตอนที่ 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("application/json")]
public class AuthorsController

[Produces]กรองจะบังคับให้การดำเนินการทั้งหมดภายใน AuthorsControllerที่จะกลับมาตอบสนองรูปแบบ JSON แม้ว่า formatters อื่น ๆ ที่ถูกกำหนดค่าสำหรับการประยุกต์ใช้และลูกค้าให้Acceptส่วนหัวขอที่แตกต่างกัน, รูปแบบที่มีอยู่

วิธีที่ 2 วิธีที่ ฉันชอบคือให้ WebAPI ตอบกลับคำขอทั้งหมดด้วยรูปแบบที่ร้องขอ อย่างไรก็ตามในกรณีที่มันไม่ยอมรับรูปแบบที่ร้องขอแล้วเลื่อนกลับไปที่ค่าเริ่มต้น (เช่น. JSON)

ก่อนอื่นคุณจะต้องลงทะเบียนในตัวเลือกของคุณ (เราจำเป็นต้องทำงานซ้ำพฤติกรรมเริ่มต้นตามที่ระบุไว้ก่อนหน้านี้)

options.RespectBrowserAcceptHeader = true; // false by default

ในที่สุดเพียงแค่สั่งรายการตัวจัดรูปแบบที่กำหนดไว้ในตัวสร้างบริการอีกครั้งเว็บโฮสต์จะใช้ค่าเริ่มต้นเป็นฟอร์แมตเตอร์ที่คุณวางไว้ที่ด้านบนของรายการ (เช่นตำแหน่ง 0)

ข้อมูลเพิ่มเติมสามารถพบได้ในรายการ. NET Web Development และ Tools Blog

คุณมีวิธีที่กำหนดไว้ล่วงหน้าสำหรับรหัสสถานะทั่วไป

• Ok(result)ส่งคืน200พร้อมการตอบกลับ
• CreatedAtRouteส่งคืน201+ URL ทรัพยากรใหม่
• NotFound ผลตอบแทน 404
• BadRequestผลตอบแทน400ฯลฯ

ดูBaseController.csและดูController.csรายการวิธีการทั้งหมด

แต่ถ้าคุณยืนยันจริง ๆ คุณสามารถใช้StatusCodeเพื่อกำหนดรหัสที่กำหนดเองได้ แต่คุณไม่ควรทำอย่างนั้นเพราะจะทำให้โค้ดอ่านง่ายขึ้นและคุณจะต้องทำซ้ำรหัสเพื่อตั้งค่าส่วนหัว (เช่นเดียวกับCreatedAtRoute)

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

ด้วยASP.NET Core 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. ทั้งสองบังคับใช้JSONในสองวิธีที่ต่างกัน
2. ทั้งสองไม่สนใจการเจรจาต่อรองเนื้อหา
3. วิธีแรกบังคับใช้ JSON กับ Json(object)serializer
4. วิธีที่สองทำเช่นเดียวกันโดยใช้Produces()attribute (ซึ่งเป็น a 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 โดยใช้ enum

     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 และให้ตัวสร้างจำนวนมากเพื่อปรับแต่งเนื้อหาและรหัสสถานะ จากนั้นแอ็คชั่นคอนโทรลเลอร์ทั้งหมดของฉันจะใช้หนึ่งในโครงสร้างต้นทุนที่เหมาะสม คุณสามารถดูการใช้งานของฉันได้ที่: https://github.com/melardev/AspNetCoreApiPaginatedCrud

และ

https://github.com/melardev/ApiAspCoreEcommerce

นี่เป็นลักษณะของคลาส (ไปที่ repo ของฉันสำหรับรหัสเต็ม):

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

สังเกตว่าฐาน (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 core 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