Bất cứ ai có thể giải thích cho createdAtRoute () cho tôi?

Từ mẫu cho API Web 2, một phương thức đăng luôn như thế này:

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

Tôi không hiểu CreatedAtRoute()phương pháp này . Bất cứ ai có thể giải thích CreatedAtRoute()phương pháp cho tôi?

Các CreatedAtRoutephương pháp được thiết kế để trả về một URI đến tài nguyên mới được tạo ra khi bạn gọi một phương thức POST để lưu trữ một số đối tượng mới. Vì vậy, nếu bạn ĐĂNG một mục đơn hàng chẳng hạn, bạn có thể trả về một tuyến đường như 'api / order / 11' (rõ ràng là 11 id của đơn đặt hàng).

BTW Tôi đồng ý rằng bài viết MSDN không có ích trong việc hiểu điều này. Lộ trình bạn thực sự quay lại sẽ tự nhiên phụ thuộc vào thiết lập định tuyến của bạn.

Khi bạn sử dụng createdAtRoute, đối số đầu tiên là tên phương thức của Get to the resource. Thủ thuật không quá rõ ràng là, ngay cả với tên phương thức chính xác được chỉ định, bạn phải sử dụng tên param trên thuộc tính HttpGet để nó hoạt động.

Vì vậy, nếu lợi nhuận trong Bài viết của bạn là thế này:

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

Sau đó, thuộc tính phương thức Get của bạn sẽ trông như thế này ngay cả khi phương thức của bạn có tên là Get:

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

Các cuộc gọi đến phương thức Post của bạn sẽ không chỉ trả về đối tượng mới (thông thường là JSON), nó sẽ đặt tiêu đề Vị trí trên phản hồi cho URI sẽ nhận tài nguyên đó.

Trong WebAPI lõi .net, bạn sử dụng phương thức này để trả về mã 201, có nghĩa là đối tượng đã được tạo.

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

Như bạn có thể thấy ở trên, createdAtRoute có thể nhận được 3 tham số:

routeName là tên mà bạn phải đặt cho phương thức sẽ là URI sẽ lấy tài nguyên đó sau khi được tạo.

routeValues Đó là đối tượng chứa các giá trị sẽ được truyền cho phương thức GET tại tuyến đã đặt tên. Nó sẽ được sử dụng để trả về đối tượng đã tạo

nội dung Đó là đối tượng đã được tạo.

Ví dụ trên cho thấy việc thực hiện hai phương thức của bộ điều khiển đơn giản với phương thức GET đơn giản với tên ngoại quan và phương thức POST tạo ra một đối tượng mới.

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

        }


    }
}

QUAN TRỌNG

1. Lưu ý rằng tham số đầu tiên tại createdAtRoute (routeName), phải giống nhau theo định nghĩa của Tên tại phương thức Get.

2. Đối tượng trên tham số thứ hai sẽ cần phải có các trường cần thiết mà bạn sử dụng để truy xuất tài nguyên trên phương thức Get, bạn có thể nói rằng đó là một tập hợp con của chính đối tượng được tạo

3. Tham số cuối cùng là đối tượng công ty nhận được trong yêu cầu cơ thể ở dạng đầy đủ.

CUỐI CÙNG

Kết quả cuối cùng, khi Bài đăng để tạo một công ty mới được tạo cho API này, bạn sẽ trả lại một tuyến đường như 'api / company / {id}' sẽ trả lại cho bạn tài nguyên mới được tạo