{"id":6517,"date":"2015-07-16T00:12:31","date_gmt":"2015-07-16T00:12:31","guid":{"rendered":"https:\/\/dev.railscarma.com\/what-is-rest-api\/"},"modified":"2020-10-16T20:46:57","modified_gmt":"2020-10-16T20:46:57","slug":"que-es-la-api-de-descanso","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/es\/blog\/articulos-tecnicos\/que-es-la-api-de-descanso\/","title":{"rendered":"\u00bfQu\u00e9 es la API REST?"},"content":{"rendered":"

API, abreviatura de interfaz de programa de aplicaci\u00f3n, es un conjunto de pr\u00e1cticas, protocolos y herramientas para crear aplicaciones de software. A veces es posible que necesitemos integraci\u00f3n de terceros para nuestra aplicaci\u00f3n web. Lograrlo REST API es algo f\u00e1cil. La ventaja de Rest API ser\u00e1 independiente del idioma.<\/p>\n

REST (Transferencia de estado representacional) es una arquitectura simple que se ejecuta a trav\u00e9s de HTTPS o TLS. El estilo REST enfatiza que las interacciones entre clientes y servicios se mejoran al tener un n\u00famero limitado de operaciones.<\/p>\n

La flexibilidad se proporciona asignando a los recursos sus propios indicadores universales de recursos (URI). Debido a que cada operaci\u00f3n (GET, POST, PUT y DELETE) tiene un significado espec\u00edfico, REST evita la incertidumbre.<\/p>\n

Construyendo una API REST simple:<\/h3>\n

La API no necesita ninguna vista ya que el usuario no interact\u00faa directamente con la aplicaci\u00f3n. Simplemente especificamos los datos que enviar\u00e1 el tercero.<\/p>\n

No habr\u00e1 ninguna acci\u00f3n de visualizaci\u00f3n o edici\u00f3n ya que no tenemos ninguna vista aqu\u00ed. Para cada solicitud se devolver\u00e1n algunos datos con un c\u00f3digo de estado y un mensaje de error de \u00e9xito. Los datos pueden tener el formato json o xml.<\/p>\n

Requisito: gema 'rails-api'<\/p>\n

Mientras crea la aplicaci\u00f3n, cree como Rails-api new [nombre_aplicaci\u00f3n], para evitar la vista, activos\/hojas de estilo y activos\/javascript.<\/p>\n

Tenemos que crear un espacio de nombres para nuestra API, lo que mantiene nuestro c\u00f3digo limpio y mantiene sus API independientes del resto de sus controladores. Comenzamos esto agregando nuestras rutas.<\/p>\n

rutas.rb<\/p>\n

espacio de nombres: api hacer
\nrecursos: usuarios
\nfin<\/p><\/blockquote>\n

Buscar\u00e1 un UsersController en app\/controllers\/api\/users_controller.rb<\/p>\n

clase api::UsersController < ApplicationController<\/p>\n

fin<\/p>\n

Espero que todos est\u00e9n familiarizados con las operaciones CRUD simples. Hagan lo mismo aqu\u00ed, pero no tendr\u00e1 ninguna vista, por lo que en lugar de la redirecci\u00f3n debemos representar algunos datos con un c\u00f3digo de estado.<\/p>\n

Por ej.<\/strong><\/p>\n

clase Api::UsersController < ApplicationController<\/p>\n

\u00edndice de definici\u00f3n
\n@usuarios = Usuario.todos
\nresponder_para hacer |formato|
\nformato.json { renderizar json: @usuarios }
\nformato.xml { renderizar xml: @usuarios }
\nfin
\nfin<\/p>\n

definitivamente destruir
\nresponder_para hacer |formato|
\nsi @ usuario.destroy
\nformat.json {head:no_content, status::Eliminado correctamente}
\nformat.xml {head:no_content, status::Eliminado correctamente}
\ndem\u00e1s
\nformat.json { renderizar json: @user.errors, estado:: No se puede }
\nformat.xml { render xml: @user.errors, estado:: No se puede }
\nfin
\nfin
\nfin<\/p>\n

fin<\/p><\/blockquote>\n

De esta manera podemos construir una API REST.<\/p>\n

Si necesita agregar alguna caracter\u00edstica nueva, cualquier cambio en su API, puede realizar versiones de su API.<\/p>\n

Versionado de API<\/strong><\/p>\n

En rutas.rb<\/p>\n

espacio de nombres: api hacer<\/p>\n

espacio de nombres: v1 hacer<\/p>\n

recursos: usuarios
\nfin
\nfin<\/p><\/blockquote>\n

Buscar\u00e1 un UsersController en
\naplicaci\u00f3n\/controladores\/api\/v1\/users_controller.rb<\/p>\n

clase Api::V1::UsersController < Controlador de aplicaciones<\/p>\n

fin<\/p>\n

Finalmente proporcione la documentaci\u00f3n API para los usuarios.<\/p>\n

Solicitudes de API:<\/p>\n

Listado de usuarios<\/p>\n

URL: http:\/\/localhost:3000\/api\/users
\nm\u00e9todo: OBTENER<\/p><\/blockquote>\n

Eliminando usuario<\/p>\n

URL: http:\/\/localhost:3000\/api\/users\/:id
\nm\u00e9todo: BORRAR<\/p><\/blockquote>\n

RailsCarma, una empresa de rieles global de renombre y marca que brinda servicios de desarrollo de RoR de alto nivel durante una d\u00e9cada. Proporciona soluciones actualizadas y de alto nivel para todos los servicios RoR.<\/p>\n

Leer art\u00edculos similares:<\/p>\n