Desarrollo de una API APP REST – Parte 2: Agregar y probar nuestros datos

Como resultado de nuestro artículo introductorio, ahora es el momento de ir a trabajar en nuestra serie REST API y comenzar a construir los fundamentos de nuestra posible aplicación. Comenzaremos las cosas ingresando datos básicos en una instalación local de WordPress, luego comenzamos a explorar algunos conceptos de fondo y el conjunto general de opciones disponibles para nosotros. Lo haremos probando la funcionalidad básica de leer y escribir la API REST con la ayuda de herramientas prácticas que facilitan el seguimiento de usuarios no técnicos. Al final de esta sesión, debemos tener una idea decente de lo que el resto realmente hace, para estar seguros de que podemos interactuar con ella localmente y estar en forma para llevar las cosas al siguiente nivel en futuros tutoriales.
Comencemos con una breve presentación general de la configuración local utilizada aquí. Nuestra configuración local para WordPress ejecuta una nueva instalación local de WordPress 4.5.3 en OSX, con veinte dieciséis instalados como tema: ¡es lo más vainilla posible! En honor al hombre que proporcionará la mayor parte del contenido con el que trabajaremos, la URL local es http://walden.dev/. También configuré mis enlaces permanentes para usar solo publicaciones, como se muestra a continuación.

En aras de una vida ligera, uso la versión gratuita de DesktoPserver, que le permite administrar fácilmente hasta tres instalaciones locales de WordPress. Se ocupa de la instalación de servidores web locales y una multitud de otros trucos de configuración potencialmente molestos con archivos de host y similares en las escenas.

Desktopserver te ayuda a mantener cosas simples. Si prefiere configurar manualmente su entorno local de WordPress, puede encontrar instrucciones para hacerlo en Mac y Windows desde Nick Schaferhoff aquí en torque. Advertencia correcta: si esta es la primera vez que intenta hacer esto, ¡prepárese para practicar un poco de paciencia y perseverancia si tiene problemas! También busqué en Goodreads y cargué una serie de citas de Henry David Thoreau como publicaciones. Entonces, en esta etapa, tenemos un sitio en funcionamiento y un contenido cargado en él. Pasemos al análisis de la API REST. Instalación de la API REST del complemento Al momento de escribir, la API REST todavía está disponible como complemento, por lo que tendremos que instalarlo antes de hacer cualquier otra cosa. No hay nada particularmente difícil de seguir aquí, se puede instalar directamente a través de back-end. o cargar manualmente .zip.
Con todo el entusiasmo sin aliento en torno al desarrollo del resto hasta ahora, puede esperar fuegos artificiales y aplausos ruidosos una vez que active el complemento, pero es una llegada muy discreta. Tendremos que tomar medidas para asegurarnos de que todo funcione. ¿Está esto en esto? Entraremos en detalles más técnicos en un segundo, pero lo primero que debe considerar es que el complemento ha abierto una forma del contenido de nuestro sitio. Ahora deberíamos poder acceder a los datos en el sitio directamente a través de una solicitud HTTP (es decir, si ingresamos la URL correcta en un navegador, deberíamos esperar ver los datos JSON devueltos).

Probemos brevemente esto de una manera rápida y sucia. Nuestra URL local es http://walden.dev/. Según la primera página de los documentos, debería ser fácil devolver una lista de publicaciones. Puse este reclamo a la prueba y solicitemos una lista de publicaciones escribiendo la dirección http://walden.dev/wp-json/ wp/v2/publicaciones.
¡Tenemos un Take -Off! Puede parecer un poco desordenado en el navegador, pero solicité información con éxito a través del resto y recibí datos estructurados en respuesta. El complemento está instalado y, al menos en un nivel muy elemental, lo que debe hacer. Ahora es un buen momento para completar algunos de los espacios gratuitos en torno a lo que acabo de hacer.

¿Qué hace realmente el resto? Comencemos con lo que realmente es un descanso. Una interfaz de programación de aplicaciones (API) es simplemente un conjunto documentado de instrucciones para la interacción programática con los datos de una aplicación. Esta es una forma elegante de decir que permite que una pieza de software hable con otra. Una API REST es un tipo de API que respeta ciertas reglas sobre la obtención de datos dentro y de una aplicación. Hay una excelente imagen general de lo que significan ambos conceptos en el video a continuación. La serie Tutorial de Tutorial REST de Todd Fredrich es otro gran recurso si desea explorar más profundo.

La forma en que interactúa con una API es a través de una solicitud web HTTP. Envíe una solicitud al servidor y reciba una respuesta estructurada. Por lo general, su solicitud requiere una especie de acción para tomar y hay cuatro cosas estándar que puede hacer:
Post (C Rate)

Obtener (R etetrieve)
Poner (u pdate)
Øteter (dcélete)
El acrónimo RAW se usa comúnmente para describir este conjunto de acciones y cubre la gran mayoría de las cosas que podría intentar hacer en el sitio o la aplicación habitual. Estas acciones se realizan contra un tipo de recurso, un objeto u objeto que queremos que ocurra. En el caso de WordPress, la API REST (al momento de la escritura) nos permite interactuar con once tipos diferentes de WordPress:
Postes
Publicar reseñas
página
Medios de comunicación
Tipos de publicaciones
Estatus de publicación
Comentario
Taxonomías
Categorías
Etiquetas
usar
Estaremos cerca de las publicaciones de esta serie casi exclusivamente, pero, como dice la documentación en sí, “lo más probable es que, si puede hacerlo con WordPress, WP API le permitirá hacerlo”. Con todo esto en mente, arrojemos los neumáticos un poco más allá en nuestro sitio local. Comenzando a través de la RAW básica para ejecutar algunas pruebas locales simples, utilizaremos la extensión Postman Chrome. Es una herramienta práctica que nos permitirá interactuar directamente con la API sin tener que eliminar ningún código (el suplemento fácil fácil hace casi lo mismo en Firefox). Usaremos Postman para probar rápidamente algunas características RAW básicas y asegurarnos de que todo funcione.
La extensión Postman Chrome nos ayuda a probar rápidamente el resto. Sabemos que la funcionalidad de recuperación básica funciona, pero verifiquemos dos veces llamando a una sola publicación. La sección de adquisición, una publicación de la documentación de referencia nos muestra que podemos hacer esto utilizando una solicitud de Geta y una identificación de publicaciones: get/wp/v2/publica/. Post ID 4 resulta ser uno de mis favoritos en el sitio local, así que lo presenté a Postman: ¡Presto! La API REST trae una sabiduría atemporal, y las diferentes partes de los datos están bien divididas en la interfaz de Postman. Ahora veamos crear una publicación. Me gustaría agregar este pequeño número: “No es lo que importa, sino lo que ves”.
Aquellos con ojos de águila entre ustedes habrán notado un texto que no dijo que no hay autenticación en la pestaña de autorización en la captura de pantalla anterior. Para las solicitudes que involucran operaciones de escritura (es decir, creación, actualización y eliminación), tendremos que probar nuestras credenciales. Si probamos una prueba rápida sin autorización, la puerta se nos mostrará a la derecha:
La autenticación es un tema en sí mismo con la API REST, pero para probar rápidamente las cosas localmente, usaremos el complemento en la autenticación básica de la mano para pasar los gorilas virtuales. Esto nos permite simplemente usar nuestros detalles de conexión de postman estándar. En el siguiente ejemplo, pasamos el contenido y el título de una nueva cita.

Las cosas se ven bien desde el punto de vista del cartero, pero vamos a la parte de atrás para asegurarnos:

¡Odio! ¡Se fue! Notará que el estado está configurado en borrador, porque olvidé especificarlo aportando API. Dejaré como un ejercicio para que el lector descubra cómo cambiar esto a través de la API misma. ¡La combinación de Postman, la documentación relevante para las publicaciones de la API REST y el complemento de Auth Basic deberían permitirle buscar una solución! Conclusión Cubré una gran cantidad de tierras en un corto período de tiempo e introduje algunas formas prácticas para que varios usuarios no técnicos interactúen rápidamente con la API REST directa. Veamos lo que hemos pasado hasta ahora: configurar una instalación local simple y completarla con contenido.
Activé y rodé la API REST del complemento y me aseguré de que realmente fuera accesible.

Ha cubierto los conceptos básicos de API en general y para lo que se puede usar en WordPress.

Se ha confirmado que podemos obtener datos dentro y desde WordPress a través de la API REST.

Es un gran comienzo y muchos otros siguen. Manténgase en el escenario para la próxima entrega, donde comenzaremos a ver las soluciones frontales que podemos usar para interactuar con nuestros datos. Como siempre, si tiene alguna pregunta o pensamiento, ¡contáctenos a través de los comentarios a continuación!