Tutorial de servicios web RESTful: Ejemplo de API REST

¿Por qué utilizar servicios web RESTful?

Antes de explorar los detalles técnicos, conviene comprender por qué REST se hizo tan popular. Los servicios web RESTful alcanzaron gran relevancia por las siguientes razones:

1. Lenguas y entornos heterogéneos – Esta es una de las razones fundamentales, que es la misma que hemos visto para JABÓN .

• Permite que las aplicaciones web desarrolladas con distintos lenguajes de programación se comuniquen entre sí.
• Con la ayuda de los servicios RESTful, estas aplicaciones web pueden residir en diferentes entornos; algunas podrían estar en Windowsy otros podrían estar en Linux.

En definitiva, independientemente del entorno, el resultado siempre debe ser el mismo: las aplicaciones deben poder comunicarse entre sí. Los servicios web RESTful ofrecen esta flexibilidad a las aplicaciones desarrolladas en diversos lenguajes de programación y plataformas.

La imagen a continuación muestra un ejemplo de una aplicación web que tiene el requisito de comunicarse con otras aplicaciones como Facebook, Twitter y Google.

Si una aplicación cliente tuviera que interactuar con sitios como Facebook y Twitter, los desarrolladores normalmente necesitarían saber en qué lenguaje y plataforma se basaron esos sitios. Con base en esa información, podrían escribir el código de interfaz, pero este enfoque podría resultar una pesadilla en cuanto a mantenimiento.

En cambio, Facebook, Twitter y Google Exponen su funcionalidad en forma de servicios web RESTful. Esto permite que cualquier aplicación cliente llame a estos servicios web mediante REST, independientemente de la tecnología subyacente.

2. El evento de los Dispositivos – Hoy en día es necesario trabajar en todo Móvil dispositivos, ya sean teléfonos móviles, ordenadores portátiles o incluso sistemas de infoentretenimiento para automóviles.

Imagínese el esfuerzo que supondría programar aplicaciones para estos dispositivos que se comunicaran con aplicaciones web convencionales. Una vez más, las API RESTful simplifican esta tarea porque, como se mencionó en el primer punto, no es necesario conocer la capa subyacente del dispositivo.

3. El evento de la Nube – Todo se está trasladando a la nube. Las aplicaciones se están trasladando lentamente a sistemas basados ​​en la nube, como por ejemplo: Azure or Amazon. Azure y Amazon Ofrece numerosas API basadas en la arquitectura REST. Por lo tanto, ahora es necesario desarrollar aplicaciones compatibles con la nube. Dado que todas las arquitecturas en la nube se basan en el principio REST, resulta lógico programar los servicios web con una arquitectura REST para aprovechar al máximo los servicios en la nube.

Elementos clave RESTful

Los servicios web REST han evolucionado mucho desde sus inicios. En 2002, el Consorcio Web publicó la definición de los servicios web WSDL y SOAP, lo que sentó las bases para la implementación de dichos servicios.

En 2004, el consorcio web también publicó la definición de un estándar adicional llamado RESTful. En los últimos años, este estándar se ha vuelto muy popular y ahora lo utilizan muchos de los sitios web más populares del mundo, incluidos Facebook y Twitter.

REST es una forma de acceder a recursos ubicados en un entorno específico. Por ejemplo, un servidor puede alojar documentos importantes, imágenes o vídeos. Todos estos son ejemplos de recursos. Si un cliente, como un navegador web, necesita alguno de estos recursos, debe enviar una solicitud al servidor. Los servicios REST definen una forma estándar de acceder a estos recursos.

Los elementos clave de una implementación RESTful son los siguientes:

1. Recursos – El primer elemento clave es el recurso en sí. Supongamos que una aplicación web en un servidor tiene registros de varios empleados. Supongamos que URL de la aplicación web es https://demo.guru99.comAhora, para acceder a un recurso de registro de empleado a través de servicios REST, se puede emitir el comando https://demo.guru99.com/employee/1Este comando le indica al servidor web que proporcione los detalles del empleado cuyo número de empleado es 1.
2. Solicitar verbos – Estos describen lo que quieres hacer con el recurso. Un navegador emite un verbo GET para indicarle al punto final que quiere obtener datos. Sin embargo, hay muchos otros verbos disponibles, incluidos POST, PUT y DELETE. Entonces, en el caso del ejemplo https://demo.guru99.com/employee/1El navegador web en realidad está emitiendo un verbo GET porque quiere obtener los detalles del registro del empleado.
3. Solicitar encabezados – Estas son instrucciones adicionales que se envían con la solicitud. Pueden definir el tipo de respuesta requerida o los detalles de autorización.
4. Cuerpo de solicitud Estos son los datos que se envían con la solicitud. Normalmente, los datos se envían en el cuerpo de la solicitud cuando se realiza una solicitud POST al servicio web REST. En una llamada POST, el cliente le indica al servicio web REST que desea agregar un recurso al servidor. Por lo tanto, el cuerpo de la solicitud contendrá los detalles del recurso que se debe agregar.
5. Cuerpo de respuesta – Este es el cuerpo principal de la respuesta. Entonces, en nuestro ejemplo de API RESTful, si consultáramos el servidor web a través de la solicitud https://demo.guru99.com/employee/1, el servidor web podría devolver un documento XML con todos los detalles del empleado en el cuerpo de la respuesta.
6. Códigos de estado de respuesta Estos son los códigos generales que se devuelven junto con la respuesta del servidor web. Un ejemplo es el código 200, que normalmente se devuelve cuando no hay ningún error al enviar una respuesta al cliente.

Métodos relajantes

El diagrama que aparece a continuación muestra la mayoría de los verbos (POST, GET, PUT y DELETE) y un ejemplo de API REST que ilustra su significado.

Supongamos que tenemos un servicio web RESTful definido en la ubicación https://demo.guru99.com/employeeCuando el cliente realiza una solicitud a este servicio web, puede especificar cualquiera de los verbos HTTP habituales: GET, POST, DELETE y PUT. A continuación se muestra lo que sucedería si el cliente enviara los verbos correspondientes.

1. PUBLICAR – Esto se usaría para crear un nuevo empleado mediante el servicio web RESTful.
2. – Esto se usaría para obtener una lista de todos los empleados que utilizan el servicio web RESTful.
3. PUT – Esto se utilizaría para actualizar a todos los empleados mediante el servicio web RESTful.
4. BORRAR – Esto se usaría para eliminar a todos los empleados que utilizan el servicio RESTful.

Ahora veamos desde la perspectiva de un solo registro. Digamos que hay un registro de empleado con el número de empleado 1. Las siguientes acciones tendrían sus respectivos significados.

1. PUBLICAR – Esto no sería aplicable, ya que estamos obteniendo datos del empleado 1, que ya está creado.
2. – Esto se usaría para obtener los detalles del empleado con el número de empleado 1 mediante el servicio web RESTful.
3. PUT – Esto se utilizaría para actualizar los datos del empleado con el número de empleado 1 mediante el servicio web RESTful.
4. BORRAR – Esto se utiliza para eliminar los datos del empleado con el número de empleado 1.

Sosegado Architectura

Una aplicación o arquitectura considerada RESTful o de estilo REST tiene las siguientes características.

1. El estado y la funcionalidad se dividen en recursos distribuidos. Esto significa que todos los recursos deben ser accesibles mediante los comandos HTTP habituales: GET, POST, PUT o DELETE. Así, si alguien quisiera obtener un archivo de un servidor, podría realizar una solicitud GET. Si quisiera subir un archivo al servidor, podría realizar una solicitud POST o PUT. Finalmente, si quisiera eliminar un archivo del servidor, podría realizar una solicitud DELETE.

2. La arquitectura es cliente/servidor, sin estado, por capas y admite almacenamiento en caché.

• Cliente-servidor es la arquitectura típica donde el servidor puede ser el servidor web que aloja la aplicación y el cliente puede ser tan simple como el navegador web.
• Sin estado significa que el estado de la aplicación no se mantiene en REST. Por ejemplo, si elimina un recurso de un servidor usando el comando DELETE, no puede esperar que la información de eliminación se pase a la siguiente solicitud.

Para asegurar que el recurso se haya eliminado, deberá realizar una solicitud GET. Esta solicitud se utilizará para obtener primero todos los recursos del servidor y, posteriormente, verificar si el recurso se eliminó correctamente.

Principios y limitaciones de RESTFul

La arquitectura REST se basa en algunas características que se detallan a continuación. Cualquier servicio web RESTful debe cumplir con estas características para poder considerarse RESTful. Estas características también se conocen como principios de diseño que deben seguirse al trabajar con servicios basados ​​en RESTful.

1. RESTFul Cliente-Servidor

   

Este es el requisito fundamental de una arquitectura basada en REST. Significa que el servidor contará con un servicio web RESTful que proporciona la funcionalidad necesaria al cliente. El cliente envía una solicitud al servicio web del servidor. El servidor, entonces, puede rechazar la solicitud o procesarla y proporcionar una respuesta adecuada al cliente.

2. Apátrida

El concepto de sistema sin estado implica que el cliente es responsable de proporcionar al servidor toda la información necesaria. Esto es fundamental para que el servidor pueda procesar la respuesta correctamente. El servidor no debe conservar ningún tipo de información entre las solicitudes del cliente. Se trata de una secuencia de preguntas y respuestas muy sencilla e independiente. El cliente formula una pregunta y el servidor la responde adecuadamente. Cuando el cliente formula otra pregunta, el servidor no recordará la secuencia anterior y deberá responder la nueva pregunta de forma independiente.

3. Cache

El concepto de caché ayuda a solucionar el problema de la falta de estado descrito en el punto anterior. Dado que cada solicitud entre el servidor y el cliente es independiente, a veces el cliente puede volver a solicitar al servidor la misma información, aunque ya la haya solicitado anteriormente. Esta solicitud se envía al servidor, que devuelve una respuesta, lo que incrementa el tráfico en la red. La caché es un concepto implementado en el cliente para almacenar las solicitudes que ya se han enviado al servidor. Así, si el cliente realiza la misma solicitud, en lugar de ir al servidor, accede a la caché para obtener la información necesaria. Esto reduce la cantidad de tráfico de red entre el cliente y el servidor.

4. Sistema de capas

El concepto de sistema por capas implica que se puede insertar una capa adicional, como una capa de middleware, entre el cliente y el servidor que aloja el servicio web RESTful. (En la capa de middleware se crea toda la lógica de negocio. Esta puede ser un servicio adicional con el que el cliente interactúa antes de realizar una llamada al servicio web). Sin embargo, la introducción de esta capa debe ser transparente para no interferir en la interacción entre el cliente y el servidor.

5. Interfaz/Conforme uniformetract

Esta es la técnica fundamental sobre cómo deberían funcionar los servicios web RESTful. RESTful funciona básicamente en la capa web HTTP y utiliza los verbos clave que se describen a continuación para interactuar con los recursos del servidor.

• POST – Para crear un recurso en el servidor.
• GET – Para recuperar un recurso del servidor.
• PUT – Para cambiar el estado de un recurso o actualizarlo.
• ELIMINAR – Para eliminar o borrar un recurso del servidor.

REST vs SOAP: Diferencias clave

Los desarrolladores suelen comparar REST con SOAP al diseñar un servicio web. Ambos permiten que las aplicaciones distribuidas se comuniquen, pero difieren notablemente en su filosofía. REST es un estilo arquitectónico que utiliza verbos HTTP simples y formatos ligeros como JSON, mientras que JABÓN es un protocolo estricto que se basa en sobres XML y una comunicación formaltract. La tabla que aparece a continuación resume las distinciones más importantes.

En la práctica, REST es la opción predeterminada para las API web y móviles públicas porque es más rápido y fácil de consumir, mientras que SOAP sigue siendo útil para sistemas empresariales que exigen seguridad integrada y una configuración formal.tracTs

Cree su primer servicio web Restful en ASP.NET

Ahora, en este tutorial de API REST, aprenderemos cómo crear un servicio web RESTful en ASP.NET.

Los servicios web se pueden crear en una variedad de lenguajes, y se pueden utilizar muchos entornos de desarrollo integrados para crear servicios basados ​​en REST.

En este ejemplo de API RESTful, crearemos nuestra aplicación REST en .NET usando Visual Studio. Tendremos un servicio web RESTful que trabajará con el siguiente conjunto de datos.

El conjunto de datos que se muestra a continuación representa un ejemplo de API REST de una empresa que expone los tutoriales que tiene en función del Tutorialid.

En nuestro ejemplo del tutorial de API REST, vamos a implementar los verbos RESTful que se muestran a continuación.

1. OBTENER Tutorial – Cuando un cliente invoca esta API RESTful, recibirá el conjunto completo de tutoriales disponibles en el servicio web.
2. OBTENER Tutorial/Tutorialid – Cuando un cliente invoca esta API RESTful, se le proporcionará el nombre del tutorial en función del Tutorialid enviado por el cliente.
3. POST Tutorial/Nombre del tutorial Cuando un cliente invoca esta API RESTful, envía una solicitud para insertar un nombre de tutorial. El servicio web agrega entonces el nombre del tutorial enviado a la colección.
4. ELIMINAR Tutorial/Tutorialid Cuando un cliente invoca esta API RESTful, envía una solicitud para eliminar un TutorialName basándose en el TutorialID. El servicio web elimina entonces el nombre del tutorial enviado de la colección.

Sigamos los pasos que se indican a continuación para crear nuestro primer servicio web RESTful, que lleva a cabo la implementación descrita anteriormente.

Cómo crear su primer servicio web relajante

Paso 1) Crea un nuevo proyecto.
El primer paso es crear un vacío. asp.net Aplicación web. Desde Visual Studio 2013, haga clic en la opción de menú Archivo->Nuevo proyecto.

Una vez que haga clic en la opción Nuevo proyecto, Visual Studio le mostrará otro cuadro de diálogo para elegir el tipo de proyecto e ingresar los detalles necesarios. Esto se explica en el siguiente paso.

Paso 2) Ingrese el nombre y la ubicación del proyecto.

1. Asegúrese de elegir primero el C# Plantilla web de la aplicación web ASP.NET. El proyecto debe ser de este tipo para crear un proyecto de servicios web. Al seleccionar esta opción, Visual Studio realizará los pasos necesarios para agregar los archivos requeridos para cualquier aplicación web.
2. Dale un nombre a tu proyecto, que en nuestro caso es “Webservice.REST”.
3. Asegúrese de indicar la ubicación donde se almacenarán los archivos del proyecto.

Una vez finalizado el proceso, verá el archivo del proyecto creado en el explorador de soluciones de Visual Studio 2013.

Paso 3) Cree el archivo del servicio web.
El siguiente paso es crear el archivo de servicio web que contendrá el servicio web RESTful.

1. Primero, haga clic con el botón derecho en el archivo del proyecto, como se muestra a continuación.

2. En este paso,
   1. Haz clic con el botón derecho en el archivo del proyecto.
   2. Seleccione la opción “Agregar->Nuevo elemento”.

En el cuadro de diálogo que aparece, debe realizar lo siguiente.

1. Seleccione la opción Servicio WCF (habilitado para Ajax). Al elegir un archivo de este tipo, Visual Studio agrega un código básico que le ayuda a crear un servicio web RESTful. WCF significa Windows Comunicación FoundationWCF es una biblioteca para que aplicaciones de diversas plataformas (o de la misma plataforma) se comuniquen a través de varios protocolos como TCP, HTTP y HTTPS. Ajax es asíncrono. JavaScript y XML. AJAX permite que las páginas web se actualicen de forma asincrónica intercambiando pequeñas cantidades de datos con el servidor detrás de escena.
2. A continuación, asigna un nombre al servicio, que en nuestro caso es TutorialService.
3. Finalmente, haga clic en el botón Agregar para agregar el servicio a la solución.

Paso 4) Haz una configuración.
El siguiente paso es realizar un cambio de configuración para permitir que este proyecto funcione con servicios web RESTful. Esto requiere un cambio en el archivo llamado web.configEste archivo aparece en la misma ventana que el archivo del proyecto del servicio web. El archivo Web.config contiene todas las configuraciones necesarias para que la aplicación web funcione correctamente. El cambio realizado permite que la aplicación envíe y reciba datos como un servicio web RESTful puro.

1. Haz clic en el archivo Web.config para abrir el código.

2. Encuentra la línea .

3. Cambia la línea a .

Paso 5) Agregue nuestro código para su implementación.
El siguiente paso es agregar nuestro código para la implementación. Todo el código que aparece a continuación debe escribirse en el archivo TutorialService.svc.

1. El primer paso consiste en añadir código para representar nuestros datos, que se utilizarán en nuestro programa. Tendremos una lista de variables de tipo cadena con los valores "Arrays", "Queues" y "Stacks". Esto representará los nombres de los tutoriales disponibles a través de nuestro servicio web de alojamiento.

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

Paso 6) Defina el código para nuestro método GET.
A continuación, definiremos el código para nuestro método GET. Este código también se encontrará en el mismo archivo TutorialService.svc y se ejecutará cada vez que accedamos al servicio desde nuestro navegador.

El método que se describe a continuación se utilizará para cumplir con el siguiente escenario.

• Si un usuario desea obtener una lista de todos los tutoriales disponibles, deberá escribir el siguiente código para lograrlo.

[WebGet(UriTemplate = "/Tutorial")]

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

Code Explicación:-

1. La primera línea de código es la más importante. Se utiliza para definir cómo podemos llamar a este método a través de un URL. Entonces, si el enlace a nuestro servicio web es http://localhost:52645/TutorialService.svc y añadimos '/Tutorial' al URL, como en http://localhost:52645/TutorialService.svc/TutorialSe invocará el código anterior. El atributo 'WebGet' es un parámetro que permite que este método sea un método RESTful, de modo que pueda invocarse mediante el verbo GET.
2. Esta sección de código se utiliza para revisar nuestra lista de cadenas en la variable 'lst' y devolverlas todas al programa que realiza la llamada.

Paso 7) Devuelve la salida.
El código que se muestra a continuación garantiza que si se realiza una llamada GET al servicio Tutorial con un ID de tutorial, se devolverá el nombre del tutorial correspondiente en función de dicho ID.

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

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

Code Explicación:-

1. La primera línea de código es la más importante. Define cómo podemos llamar a este método a través de un URL. Entonces, si el enlace a nuestro servicio web es http://localhost:52645/TutorialService.svc y añadimos '/Tutorial/{Tutorialid}' al URL, podríamos llamar al servicio web como http://localhost:52645/TutorialService.svc/Tutorial/1, por ejemplo. El servicio web devolvería entonces el nombre del tutorial que tuviera el ID de tutorial 1.
2. Esta sección de código se utiliza para devolver el nombre del tutorial que tiene el ID de tutorial pasado al método web.

• Por defecto, lo que hay que recordar es que lo que se le pasa al URL En el navegador hay una cadena.
• Pero hay que recordar que el índice de nuestra lista tiene que ser un número entero, por lo que añadimos el código necesario para convertir primero el Tutorialid a un número entero.
• Luego lo usamos para acceder a la posición del índice en nuestra lista y devolver el valor al programa que lo llamó.

Paso 8) Escribe el código para el método POST.
El siguiente paso es escribir el código para nuestro método POST. Este método se invocará cada vez que queramos agregar un valor de cadena a nuestra lista de tutoriales mediante el método POST. Por ejemplo, si quisieras agregar el nombre del tutorial "Pruebas de software", tendrías que usar el método POST.

[WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped,
UriTemplate = "/Tutorial/{str}")]

public void AddTutorial(String str)
{
    lst.Add(str);
}

Code Explicación:-

1. La primera línea corresponde al atributo 'WebInvoke', que se ha asociado a nuestro método. Esto permite invocar el método mediante una llamada POST. Los atributos RequestFormat y ResponseFormat deben especificarse como JSON, ya que al enviar valores a un servicio web RESTful, estos deben estar en dicho formato.
2. La segunda línea de código se utiliza para agregar el valor de cadena pasado a través de la llamada POST a nuestra lista existente de cadenas de tutoriales.

Paso 9) Agregue un método para manejar la operación DELETE.
Finalmente, agregaremos nuestro método para gestionar la operación DELETE. Este método se invocará siempre que queramos eliminar un valor de cadena existente de nuestra lista de tutoriales mediante el método DELETE.

[WebInvoke(Method = "DELETE", RequestFormat = WebMessageFormat.Json,
UriTemplate = "/Tutorial/{Tutorialid}", ResponseFormat = WebMessageFormat.Json,
BodyStyle = WebMessageBodyStyle.Wrapped)]

public void DeleteTutorial(String Tutorialid)
{
    int pid;
    Int32.TryParse(Tutorialid, out pid);
    lst.RemoveAt(pid);
}

Code Explicación:-

1. La primera línea corresponde al atributo 'WebInvoke', que se ha asociado a nuestro método. Esto permite invocar el método mediante la llamada DELETE. Los atributos RequestFormat y ResponseFormat deben especificarse como JSON, ya que los valores deben estar en este formato. Tenga en cuenta que el parámetro Method se establece en "DELETE". Esto significa que, cada vez que se ejecute el comando DELETE, se invocará este método.
2. La segunda línea de código se utiliza para tomar el Tutorialid enviado a través de la llamada DELETE y posteriormente eliminar esa identificación de nuestra lista. (El Int32 La función del código se utiliza para convertir el ID del tutorial de una variable de cadena a un número entero.

Ejecutando su primer servicio web Restful

Ahora que hemos creado nuestro servicio web completo en la sección anterior, veamos cómo podemos ejecutar el servicio Tutorial para que pueda ser invocado desde cualquier cliente.

Para ejecutar el servicio web, siga los pasos que se indican a continuación.

Paso 1) Haga clic con el botón derecho en el archivo del proyecto: Webservice.REST.

Paso 2) Seleccione la opción de menú "Establecer como proyecto de inicio". Esto garantizará que este proyecto se ejecute cuando Visual Studio ejecute la solución completa.

Paso 3) El siguiente paso es ejecutar el proyecto. Dependiendo del navegador predeterminado instalado en el sistema, el nombre del navegador correspondiente aparecerá junto al botón de ejecución en Visual Studio. En nuestro caso, tenemos Google Chrome Apareciendo. Simplemente haga clic en este botón.

Salida:-

Cuando se ejecute el proyecto, puede navegar a la sección TutorialService.svc/Tutorial y obtendrá el resultado que se muestra a continuación.

En la salida anterior,

• Como puede observar, el navegador invoca el verbo 'GET' y ejecuta el método 'GetAllTutorial' del servicio web. Este módulo se utiliza para mostrar todos los tutoriales disponibles a través de nuestro servicio web.

Probando su primer servicio web Restful

En la sección anterior, ya hemos visto cómo usar el navegador para ejecutar el verbo 'GET' e invocar 'GetAllTutorial'.

1. Utilicemos ahora el navegador para ejecutar el siguiente escenario de caso de uso.

GET Tutorial/Tutorialid: cuando un cliente invoca esta API RESTful, se le proporcionará el nombre del tutorial en función del Tutorialid enviado por el cliente.

En su navegador, agregue la cadena /1 después de la palabra Tutorial en el URLSi pulsas el botón de intro, obtendrás el siguiente resultado.

Ahora verá el resultado de "Colas", que corresponde al número 1 en nuestra lista de cadenas de tutoriales. Esto significa que el método 'GetTutorialbyID' se está invocando desde nuestro servicio web. También muestra que el valor 1 se está pasando correctamente a través del navegador a nuestro servicio web y a nuestro método, y por eso obtenemos el valor correcto de "Colas" en el navegador.

2. A continuación, consumamos nuestro servicio web ejecutando el siguiente escenario. Para ello, necesita instalar la herramienta llamada Fiddler, que es una herramienta gratuita que se puede descargar.

POST Tutorial/Tutorialname: Cuando un cliente invoca esta API RESTful, envía una solicitud para insertar un TutorialName. El servicio web agrega el nombre del tutorial enviado a la colección.

Ejecute el Fiddler Utilice la herramienta y siga los pasos que se indican a continuación.

1. Dirígete a la sección de composición. Aquí se crea la solicitud de datos que se puede enviar a cualquier aplicación web.
2. Asegúrese de que el tipo de solicitud sea "POST" y correcto. URL está siendo golpeado, lo cual en nuestro caso debería ser http://localhost:52645/TutorialService.svc/Tutorial.
3. Asegúrese de que el Content-Type esté marcado como application/json. Recuerde que nuestro método de solicitud POST en nuestro servicio web solo acepta datos en formato JSON, por lo que debemos asegurarnos de que esto se especifique al enviar una solicitud a nuestra aplicación.
4. Finalmente, debemos ingresar nuestros datos. Recuerda que nuestro método POST acepta un parámetro llamado 'str'. Aquí especificamos que queremos agregar un valor llamado "Trees" a nuestra colección de nombres de tutoriales y asegurarnos de que esté asociado a la variable 'str'.

Finalmente, solo haga clic en el botón Ejecutar en Fiddler. Esto enviará una solicitud al servicio web para que envíe los datos “Árboles” a nuestro servicio web mediante POST.

Ahora, cuando navegamos al Tutorial URL Para mostrar todas las cadenas de nuestra lista de tutoriales, verá que el valor "Trees" también está presente. Esto demuestra que la solicitud POST al servicio web se ejecutó correctamente y que se agregó correctamente a nuestra lista de tutoriales.

3. A continuación, consumamos nuestro servicio web ejecutando el siguiente escenario. Para ello, también necesitamos utilizar el Fiddler .

ELIMINAR Tutorial/Tutorialid: Cuando un cliente invoca esta API RESTful, envía una solicitud para eliminar un TutorialName basándose en el TutorialID. El servicio web elimina entonces el nombre del tutorial enviado de la colección.

Ejecute el Fiddler Utilice la herramienta y siga los pasos que se indican a continuación.

1. Dirígete a la sección de composición. Aquí se crea la solicitud de datos que se puede enviar a cualquier aplicación web.
2. Asegúrese de que el tipo de solicitud sea "DELETE" y correcto. URL está siendo golpeado, lo cual en nuestro caso debería ser http://localhost:52645/TutorialService.svc/TutorialAsegúrese de que el ID utilizado para eliminar una cadena en la lista se envíe a través de URL como parámetro. En nuestro ejemplo REST, estamos enviando 1, por lo que esto eliminará el 2.^nd elemento en nuestra colección, que es “Colas”.

Finalmente, solo haga clic en el botón Ejecutar en Fiddler. Esto enviará una solicitud al servicio web para ELIMINAR los datos “Colas” de nuestro servicio web.

Ahora, cuando navegamos al Tutorial URL Para mostrar todas las cadenas de nuestra lista de tutoriales, observará que el valor de "Colas" ya no está presente.

Esto demuestra que la solicitud DELETE al servicio web se ejecutó correctamente. El elemento en el índice número 1 de nuestra lista de cadenas del tutorial se eliminó correctamente.

Mejores prácticas de API RESTful

Crear una API REST funcional es solo el primer paso; construir una que sea escalable y fácil de mantener requiere disciplina. Las prácticas que se describen a continuación ayudan a que tus puntos de acceso sean predecibles, seguros y fáciles de usar para otros desarrolladores y agentes de IA.

• Utilice sustantivos, no verbos, en URLs. Puntos finales como /empleados/1 son más claros que /getEmployee?id=1, porque el verbo HTTP ya describe la acción.
• Devuelve códigos de estado significativos. Envíe 200 para éxito, 201 para un recurso creado, 400 para una solicitud incorrecta, 401 para acceso no autorizado, 404 para un recurso faltante y 500 para errores del servidor.
• Versiona tu API. Agregar un segmento de versión como por ejemplo /v1/ Esta ruta te permite evolucionar el servicio sin perjudicar a los clientes existentes.
• Proteja todos los puntos finales. Utilice HTTPS, junto con claves API o tokens OAuth 2.0, y valide todos los datos de entrada.
• Admite paginación y filtrado. Devolver colecciones grandes en páginas mantiene las respuestas rápidas y reduce la carga del servidor.

Seguir estas convenciones hace que la integración de su servicio web RESTful sea intuitiva, ya sea que el consumidor sea una aplicación móvil, un sistema asociado o un flujo de trabajo de IA automatizado.

Preguntas Frecuentes