4) Веб-сервисы RESTful

1. Выберите опцию Служба WCF (с поддержкой Ajax) — выберите файл этого типа, он заставляет Visual Studio добавить некоторый базовый код, который помогает создать веб-службу RESTful. WCF обозначает Windows Communication Foundation. WCF — это библиотека для приложений различных платформ или одной и той же платформы для связи по различным протоколам, таким как TCP, HTTP, HTTPS. В основном Ajax — это асинхронный JavaScript и XML. AJAX позволяет асинхронно обновлять веб-страницы, обмениваясь небольшими объемами данных с сервером за кулисами.
2. Затем дайте имя для службы, которая в нашем случае называется TutorialService.
3. Наконец, нажмите кнопку Добавить, чтобы добавить службу в решение.

Шаг 4) Следующим шагом является изменение конфигурации, чтобы этот проект мог завершить работу с веб-сервисами RESTful. Для этого необходимо внести изменения в файл с именем Web.config . Этот файл появляется в том же окне, что и файл проекта Webservice. Файл Web.config содержит все конфигурации, которые заставляют веб-приложение работать должным образом. Вносимые изменения фактически позволяют приложению отправлять и получать данные как чистый веб-сервис RESTful.

1. Нажмите на файл Web.config, чтобы открыть код

2. Найти по строке <enableWebScript>

3. Измените строку на <webHttp>

Шаг 5) Следующий шаг — добавить наш код для реализации. Весь приведенный ниже код должен быть записан в файле TutorialService.svc

1. Первый шаг — добавить код для представления наших данных, которые будут использоваться в нашей программе. Итак, у нас будет список строковых переменных со значениями «Массивы», «Очереди» и «Стеки». Это будет название учебника, доступное через наш веб-сервис.

namespace Webservice.REST
{
	[ServiceContract(Namespace = "")]
	[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed
	public class TutorialService
	{
		private static List lst = new List 
		(new String[] {"Arrays","Queues","Stacks"});

Шаг 6) Далее мы определим код для нашего метода GET. Этот код также будет находиться в том же файле TutorialService.svc. Этот код будет запускаться всякий раз, когда мы вызываем сервис из нашего браузера.

Приведенный ниже метод будет использоваться для выполнения нижеприведенного сценария.

• Если пользователь хочет получить список всех доступных учебников, то для этого необходимо написать приведенный ниже код.

[WebGet(UriTemplate="/Tutorial")]

public String GetAllTutorial()
{
	int count = 1st.Count;
	String TutorialList = "";
	for (int i = 0; i < count; i++)
	TutorialList = TutorialList + lst[i] + ",";
	return TutorialList;
}

Объяснение кода: —

1. Первая строка кода является наиболее важной. Он используется для определения того, как мы можем вызвать этот метод через URL. Так что, если ссылка на наш веб-сервис — http: // localhost: 52645 / TutorialService.svc и если мы добавляем «/ Tutorial» к URL-адресу как http: // localhost: 52645 / TutorialService.svc / Tutorial , приведенный выше код будет вызван. Атрибут ‘WebGet’ является параметром, который позволяет этому методу быть методом RESTful, чтобы его можно было вызывать через глагол GET.
2. Этот раздел кода используется для просмотра нашего списка строк в переменной ‘lst’ и возврата их всех в вызывающую программу.

Шаг 7) Приведенный ниже код гарантирует, что если в службу Tutorial Service будет выполнен вызов GET с идентификатором Tutorial, то он вернет соответствующее имя Tutorial на основе идентификатора Tutorial.

[WebGet (UriTemplate = "/Tutorial/{Tutorialid}")]

public String GetTutorialbyID(String Tutorialid)
{
	int pid;
	Int32.TryParse(Tutorialid, out pid);
	return lst[pid];
}

Объяснение кода: —

1. Первая строка кода является наиболее важной. Он используется для определения того, как мы можем вызвать этот метод через URL. Поэтому, если ссылка на наш веб-сервис — http: // localhost: 52645 / TutorialService.svc, и если мы добавим ‘/ Tutorial / {Tutorialid}’ к URL-адресу, мы сможем вызвать веб-сервис как http: //localhost:52645/TutorialService.svc/Tutorial/1 в качестве примера. Затем веб-сервис должен будет вернуть имя Tutorial с идентификатором Tutorial # 1.
2. Этот раздел кода используется для возврата «имени учебника», в котором идентификатор учебника передается веб-методу.

• По умолчанию необходимо помнить, что все, что передается на URL в браузере, является строкой.
• Но вы должны помнить, что индекс в нашем списке должен быть целым числом, поэтому мы добавляем необходимый код, чтобы сначала преобразовать Tutorialid в целое число, а затем использовать его для доступа к позиции индекса в нашем списке и
• Затем верните значение вызывающей программе соответственно.

Шаг 8) Следующий шаг — написать код для нашего метода POST. Этот метод будет вызываться всякий раз, когда мы хотим добавить строковое значение в наш список учебных пособий с помощью метода POST. Например, если вы хотите добавить название учебника «Тестирование программного обеспечения», вам нужно будет использовать метод POST.

Объяснение кода: —

1. Первая строка — это атрибут «WebInvoke», который был присоединен к нашему методу. Это позволяет вызывать метод через вызов POST. Атрибуты RequestFormat и ResponseFormat должны быть упомянуты как JSON, поскольку при публикации значений в веб-сервис RESTFul значения должны быть в этом формате.
2. Вторая строка кода используется для добавления строкового значения, переданного через вызов POST, в наш существующий список строк Tutorial.

Шаг 9) Наконец, мы собираемся добавить наш метод для обработки операции DELETE. Этот метод будет вызываться всякий раз, когда мы хотим удалить существующее строковое значение из нашего списка учебных пособий с помощью метода DELETE.

[WebInvoke(Method = "DELETE", RequestFormat = WebMessageFormat.Ison,
	UriTemplate = "/Tutorial/{Tutorialid}", ResponseFormat = WebMessageFormat.Json,
	BodyStyle = WebMessageBodyStyle.Wrapped)]
	
public void DeleteTutorial(String Tutorialid)
{
	int pid;
	Int32.TryParse(Tutorialid, out pid);
	1st.RemoveAt(pid);
}

Объяснение кода: —

1. Первая строка — это атрибут «WebInvoke», который был присоединен к нашему методу. Это позволяет вызывать метод через вызов POST. Атрибуты RequestFormat и ResponseFormat должны быть упомянуты как JSON, поскольку при публикации значений в веб-сервис RESTFul значения должны быть в этом формате. Обратите внимание, что для параметра Method установлено значение «DELETE». Это означает, что всякий раз, когда мы выдаем команду DELETE, этот метод будет вызываться.
2. Вторая строка кода используется для получения Tutorialid, отправленного с помощью вызова DELETE, и последующего удаления этого идентификатора из нашего списка. (Функция Int32 в коде используется для преобразования идентификатора учебника из строковой переменной в целое число).

Запуск вашего первого веб-сервиса Restful

Теперь, когда мы создали весь наш веб-сервис в разделе выше. Давайте посмотрим, как мы можем запустить службу Tutorial, чтобы ее можно было вызывать из любого клиента.

Чтобы запустить веб-сервис, выполните следующие действия.

Шаг 1) Щелкните правой кнопкой мыши файл проекта — Webservice.REST

Шаг 2) Выберите пункт меню «Сделать стартовым проектом». Это обеспечит запуск этого проекта, когда Visual Studio запустит все решение.

Шаг 3) Следующий шаг — запустить сам проект. Теперь, в зависимости от установленного в системе браузера по умолчанию, соответствующее имя браузера появится рядом с кнопкой запуска в Visual Studio. В нашем случае у нас появляется Google Chrome. Просто нажмите на эту кнопку.

Вывод:-

Когда проект будет запущен, вы можете перейти в раздел TutorialService.svc / Tutorial, и вы получите следующий вывод.

В приведенном выше выводе,

• Вы можете видеть, что браузер вызывает глагол «GET» и выполняет метод «GetAllTutorial» в веб-сервисе. Этот модуль используется для отображения всех учебных пособий, предоставляемых нашим веб-сервисом.

Тестирование вашего первого веб-сервиса Restful

В предыдущем разделе мы уже видели, как использовать браузер для выполнения глагола «GET» и вызова «GetAllTutorial».

1. Давайте теперь используем браузер для выполнения следующего сценария использования.

GET Tutorial / Tutorialid — Когда клиент вызывает этот Restful API, ему будет присвоено имя Tutorial на основе Tutorialid, отправленного клиентом.

В вашем браузере добавьте строку / 1 после слова Tutorial в URL. Если вы нажмете кнопку ввода, вы получите ниже вывод

Теперь вы увидите выходные данные Queues, которые на самом деле соответствуют числу 1 в нашем списке строк учебника. Это означает, что метод GetTutorialbyID теперь вызывается из нашего веб-сервиса. Это также показывает, что значение 1 успешно передается через браузер в наш веб-сервис и в наш метод, и поэтому мы получаем правильное соответствующее значение «Очереди» в браузере.

2. Далее давайте использовать наш веб-сервис, выполнив следующий сценарий. Для этого вам необходимо установить инструмент под названием «Fiddler», который можно бесплатно загрузить с сайта.

POST Tutorial / Tutorialname — Когда клиент вызывает этот Restful API, клиент отправит запрос на вставку Tutorialname. Затем веб-служба добавит имя отправленного учебника в коллекцию.

Запустите инструмент Filddler и выполните следующие шаги;

1. Перейти в раздел композитора. Это используется для создания запросов, которые могут быть отправлены на любой веб

   применение.

2. Убедитесь, что тип запроса «POST» и правильный URL-адрес, который в нашем случае должен быть http: // localhost: 52645 / TutorialService.svc / Tutorial
3. Убедитесь, что Content-Type помечен как application / json. Помните, что наш метод POST-запроса в нашем веб-сервисе принимает только данные в стиле json, поэтому мы должны убедиться, что это указано при отправке запроса в наше приложение.
4. Наконец, нам нужно ввести наши данные. Помните, что наш метод для POST принимает параметр с именем ‘str.’ Поэтому здесь мы указываем, что мы хотим добавить значение под названием «Деревья» в нашу коллекцию имен Tutorial и убедиться, что оно помечено как имя переменной str.

Наконец, просто нажмите кнопку «Выполнить» в Fiddler. Это отправит запрос в веб-сервис для размещения данных «Деревья» в нашем веб-сервисе.

Теперь, когда мы перейдем к URL-адресу Tutorial, чтобы показать все строки в нашем списке Tutorial, вы увидите, что значение «Trees» также присутствует. Это показывает, что запрос POST к веб-службе был успешно выполнен и что он был успешно добавлен в наш учебный список.

3. Далее давайте использовать наш веб-сервис, выполнив следующий сценарий. Для этого также нам нужно использовать инструмент Fiddler

УДАЛИТЬ Tutorial / Tutorialid — Когда клиент вызывает этот Restful API, клиент отправит запрос на удаление имени Tutorialid на основе Tutorialid. Затем веб-служба удалит отправленное имя учебника из коллекции.

Запустите инструмент Filddler и выполните следующие шаги

1. Перейти в раздел композитора. Это используется для создания запросов, которые могут быть отправлены на любой веб

   применение.

2. Убедитесь, что типом запроса является «УДАЛИТЬ», и выполняется поиск правильного URL-адреса, который в нашем случае должен быть http: // localhost: 52645 / TutorialService.svc / Tutorial . Убедитесь, что идентификатор, который используется для удаления строки в списке, отправляется через URL в качестве параметра. В нашем примере, мы посылаем 1 так что это приведет к удалению 2 — ^й элемент в нашей коллекции , которая «очередями».

Наконец, просто нажмите кнопку «Выполнить» в Fiddler. Это отправит запрос в веб-сервис для УДАЛЕНИЯ данных «Очереди» в наш веб-сервис.

Теперь, когда мы перейдем к URL-адресу учебника, чтобы показать все строки в нашем списке учебников, вы заметите, что значение «Очереди» больше не присутствует.

Это показывает, что запрос DELETE к веб-службе был успешно выполнен. Элемент с индексом № 1 в нашем списке строк Tutorial был успешно удален.

Резюме

• REST означает REpresentational State Transfer. REST используется для создания веб-служб, которые являются легкими, поддерживаемыми и масштабируемыми по своей природе.
• Все больше и больше приложений переходят на архитектуру Restful. Это связано с тем, что сейчас многие люди используют мобильные устройства, а более широкое разнообразие приложений перемещается в облако.
• Основными аспектами REST являются ресурсы, которые находятся на сервере, и глаголы GET, POST, PUT и DELETE, которые можно использовать для работы с этими ресурсами.
• Visual Studio и .Net могут быть использованы для создания веб-служб Restful.
• При тестировании веб-сервисов для POST и PUT вам нужно использовать другой инструмент, называемый fiddler, который можно использовать для отправки запроса POST и PUT на сервер.