2012-04-27 46 views
13

Tôi muốn đọc về các quy ước đặt tên của API MVC4 WEB, nhưng tôi không thể tìm thấy bất kỳ tài liệu nào về nó. Tôi muốn biết nếu tôi có thể tạo điểm cuối với tên tùy chỉnh và nếu có, làm cách nào tôi có thể làm điều đó?Quy ước đặt tên yêu cầu HTTP API Web

+0

Bạn có ý gì khi yêu cầu quy ước đặt tên? Bạn có nghĩa là định tuyến? Mang ví dụ về điểm cuối tùy chỉnh bạn muốn tạo. – Aliostad

Trả lời

15

Nếu bạn muốn hiểu cách bạn có thể định cấu hình các tuyến cho hành động của bộ điều khiển của mình (tôi tin đây là ý nghĩa của các điểm cuối trong ngữ cảnh này), bạn nên đọc Routing in ASP.NET Web API bài viết.

9

Quy ước trong API Web MVC4 là url bắt đầu bằng/api/sau đó có tên bộ điều khiển của bạn. Từ đó, bạn không chỉ định tên hành động như bình thường. Hành động điều khiển được xác định theo loại yêu cầu (GET, PUT, POST, DELETE). Vì vậy, bạn có thể tạo bất kỳ điểm kết thúc nào mà bạn muốn bằng cách tạo một bộ điều khiển kế thừa từ Bộ điều khiển API.

Quy ước là; - Bộ điều khiển làm tên lớp bộ điều khiển của bạn. -/api/như uri.

Giả sử bạn muốn có bộ điều khiển tác vụ. Tạo một bộ điều khiển TasksController với phương thức Get(), sau đó uri sẽ là/api/tasks.

Điều tương tự cũng xảy ra với PUT, DELETE và POST.

Vì vậy, một lần nữa để trả lời câu hỏi của bạn ... "Tôi muốn biết nếu tôi có thể tạo điểm cuối với tên tùy chỉnh và nếu có, làm thế nào tôi có thể làm điều đó?"

Bạn có thể. Chỉ cần tạo một bộ điều khiển kế thừa từ ApiController. Bạn có thể đặt tên cho nó bất cứ thứ gì bạn muốn làm nhật ký khi nó kết thúc bằng Bộ điều khiển. tức là (MyController, TasksController, vv)