ASP.NET MVC 4 — веб-API

ПОЛУЧИТЬ действия

 public List<Product> Get() {  
 return _productsRepository.ToList();  
}  

public Product Get(int id) {  
 return _productsRepository.First(p => p.ID == id);  
}

Обратите внимание, как я определил два действия Get? Это потому, что когда пользователь вызывает API, он передает метод HTTP. Если входящий запрос является запросом GET и не имеет идентификатора, он вызовет действие Get, чтобы вернуть список продуктов. Если идентификатор есть, он вызывает действие Get для определенного продукта. Красиво и просто. И как вы можете проверить этот код? Я собираюсь использовать Fiddler для этого. Если вы никогда не использовали это, вы должны получить это сейчас.

Используя Fiddler, я могу создать запрос GET в компоновщике Composer. Вызов http: // localhost: 1717 / Product вернет список товаров.

Если я хочу только один продукт, я могу передать в ID; HTTP: // локальный: 1717 / Product / 1. По умолчанию JSON возвращается из всех методов действия. Если вам нужен другой формат, например XML, просто добавьте в заголовок приложения Accept application / xml:

Не изменяя код, он возвращает результат в XML.

POST Actions

 public void Post(Product product) {  
 _productsRepository.Add(product) 
}

Следующие запросы GET являются запросами POST. Это где данные будут созданы. Опять же, я назвал действие так же, как глагол HTTP, поэтому все, что мне нужно изменить, — это добавить Content-Type в application / json и отправить объект JSON. Я могу добавить следующие заголовки запроса в Fiddler, чтобы опубликовать новый продукт.

Если вы проверите код ответа HTTP, вы увидите, что он возвращает 200, что нормально, но для POST в идеале он должен возвращать код состояния 201. Это будет указывать пользователю, что продукт был успешным. Также 201 должен иметь значение Location, поэтому мы добавим и это.

 public HttpResponseMessage<Product> Post(Product product) {     
 _productsRepository.Add(product);     
 var response = new HttpResponseMessage<Product>(product, HttpStatusCode.Created);     
 string uri = Url.Route("http://localhost:1717/", new { id = contact.Id });     
 response.Headers.Location = new Uri(Request.RequestUri, uri);     
 return response; 
}

Вместо возврата void мы возвращаем новый тип HttpResponseMessage <T>. Это дает вам гибкость в изменении возвращенного кода состояния, а также заголовков ответов. Теперь, если вы запустите это через Fiddler, вы увидите возвращенный 201 плюс заголовок Location .

PUT Actions

 public void Put(Product product) { 
 _productsRepository.Update(product) 
}

Положите действия по обновлению ресурсов, так что возвращение 200 или 204 вполне подойдет. По умолчанию возвращается 200, поэтому по этой причине нам не нужно ничего делать с действием.

Стоит отметить, что для поста и положенных действий я отправляю JSON. Если я изменю тип контента на XML, я мог бы легко отправлять XML вместо JSON без необходимости изменения какого-либо кода в API. Web API автоматически разбивает входящий запрос на строго типизированные объекты и сопоставляет свойства имени.

УДАЛИТЬ Действия

 public void Delete(Product product) { 
 _productsRepository.Delete(product) 
}

Действия удаления удаляют ресурсы, поэтому в зависимости от того, удален ли ресурс немедленно или на более позднем этапе, можно определить код состояния. Если ресурс удален немедленно, код состояния должен быть 200. Если удаление для более поздней стадии, тогда должен быть возвращен код состояния 202.

 public HttpResponseMessage<Product> Delete(Product product) { 
 _productsRepository.Delete(product); 
 var response = new HttpResponseMessage<Product>(product, HttpStatusCode.Deleted); 
 return response; 
}

Я только поверхностно изучил веб-API, и в ближайшие недели я буду исследовать различные способы его использования.