ใครช่วยอธิบาย CreatedAtRoute () ให้ฉันฟังได้ไหม

จากเทมเพลตสำหรับ Web API 2 วิธีการโพสต์จะเป็นเช่นนี้เสมอ:

[ResponseType(typeof(MyDTO))]
public IHttpActionResult PostmyObject(MyDTO myObject)
{
    ...
    return CreatedAtRoute("DefaultApi", new { id = myObject.Id }, myObject);
}

ฉันไม่เข้าใจCreatedAtRoute()วิธีนี้ ใครสามารถอธิบายCreatedAtRoute()วิธีการให้ฉัน?

CreatedAtRouteวิธีมีจุดมุ่งหมายเพื่อกลับ URI กับทรัพยากรที่สร้างขึ้นใหม่เมื่อคุณเรียกวิธีการโพสต์ในการจัดเก็บวัตถุใหม่บางส่วน ดังนั้นหากคุณโพสต์รายการสั่งซื้อคุณอาจส่งคืนเส้นทางเช่น 'api / order / 11' (11 เป็นรหัสของคำสั่งซื้ออย่างชัดเจน)

BTW ฉันยอมรับว่าบทความ MSDN ไม่มีประโยชน์ในการทำความเข้าใจเรื่องนี้ เส้นทางที่คุณกลับจริงจะขึ้นอยู่กับการตั้งค่าเส้นทางของคุณ

เมื่อคุณใช้ CreatedAtRoute อาร์กิวเมนต์แรกคือชื่อเมธอดของ Get to the resource เคล็ดลับที่ไม่ชัดเจนนักคือแม้จะระบุชื่อเมธอดที่ถูกต้อง แต่คุณต้องใช้ Name param ในแอตทริบิวต์ HttpGet เพื่อให้ใช้งานได้

ดังนั้นหากผลตอบแทนในโพสต์ของคุณคือ:

return CreatedAtRoute("Get", new { newModel.Id}, newModel);

แอตทริบิวต์ Get method ของคุณควรมีลักษณะเช่นนี้แม้ว่าเมธอดของคุณจะมีชื่อว่า Get:

[HttpGet("{id}", Name = "Get")]

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

ใน WebAPI. net core คุณใช้วิธีนี้เพื่อส่งคืนรหัส 201 ซึ่งหมายความว่าวัตถุนั้นถูกสร้างขึ้น

[Microsoft.AspNetCore.Mvc.NonAction]
public virtual Microsoft.AspNetCore.Mvc.CreatedAtRouteResult CreatedAtRoute (string routeName, object routeValues, object content);

ดังที่คุณเห็นด้านบน CreatedAtRoute สามารถรับ 3 พารามิเตอร์:

routeName คือชื่อที่คุณต้องใส่เมธอดที่จะเป็น URI ที่จะได้รับทรัพยากรนั้นหลังจากสร้าง

routeValues เป็นวัตถุที่มีค่าที่จะส่งต่อไปยังเมธอด GET ที่เส้นทางที่ตั้งชื่อ จะใช้เพื่อส่งคืนวัตถุที่สร้างขึ้น

เนื้อหา เป็นวัตถุที่สร้างขึ้น

ตัวอย่างข้างต้นแสดงการใช้งานสองวิธีของตัวควบคุมแบบง่ายด้วยเมธอด GET แบบง่ายที่มีชื่อผูกมัดและวิธีการ POST ที่สร้างวัตถุใหม่

namespace BastterAPI.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class CompanyController : Controller
    {
        private ICompanyRepository _companyRepository;

        public CompanyController(ICompanyRepository companyRepository)
        {
            _companyRepository = companyRepository;
        }

        [HttpGet("{id}", Name="GetCompany")]
        public IActionResult GetById(int id)
        {
            Company company = _companyRepository.Find(id);

            if (company == null)
            {
                return NotFound();
            }

            return new ObjectResult(company);

        }

        [HttpPost]
        public IActionResult Create([FromBody] Company company)
        {

            if (company == null)
            {
                return BadRequest();
            }

            _companyRepository.Add(company);

            return CreatedAtRoute("GetCompany", new Company { CompanyID = company.CompanyID }, company);

        }


    }
}

สิ่งสำคัญ

1. โปรดสังเกตว่าพารามิเตอร์แรกที่ CreatedAtRoute (routeName) ต้องเหมือนกันที่นิยามของ Name ที่เมธอด Get

2. ออบเจ็กต์ในพารามิเตอร์ที่สองจะต้องมีฟิลด์ที่จำเป็นที่คุณใช้ในการดึงทรัพยากรในเมธอด Get คุณสามารถพูดได้ว่าเป็นส่วนย่อยของอ็อบเจ็กต์ที่สร้างขึ้นเอง

3. พารามิเตอร์สุดท้ายคือวัตถุของ บริษัท ที่ได้รับในคำขอเนื้อหาในรูปแบบเต็ม

FINALY

ผลสุดท้ายเมื่อโพสต์เพื่อสร้าง บริษัท ใหม่ที่สร้างขึ้นใน API นี้คุณจะส่งคืนเส้นทางเช่น "api / company / {id}" ซึ่งจะส่งคืนทรัพยากรที่สร้างขึ้นใหม่ให้คุณ