Ir al contenido

RAML (lenguaje)

De Wikipedia, la enciclopedia libre
Este artículo o sección necesita ser wikificado, por favor, edítalo para que cumpla con las convenciones de estilo.
Este aviso fue puesto el 9 de mayo de 2021.
RAML (lenguaje)
Desarrollador
Grupo de trabajo RAML
https://raml.org/
Información general
Extensión de archivo raml
Tipo de MIME application/raml+yaml
Última versión 1.0 (16 de mayo de 2016)
Extendido de YAML
Estándar(es) https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/
Formato abierto ?
[editar datos en Wikidata]

RESTful API Modeling Language (RAML) es un lenguaje de modelado para definir APIs RESTful con una sintaxis sencilla y fácilmente comprensible tanto para los seres humanos como para sistemas software.[1]​ Básicamente es una especificación no propietaria y totalmente independiente basada en YAML y JSON, es decir, permite escribir la especificación de las APIs siguiendo un estándar. Proporciona toda la información necesaria para describir las API RESTful o prácticamente RESTful. Aunque está diseñado teniendo en cuenta las API RESTful, RAML es capaz de describir las API que no obedecen a todas las restricciones del REST (de ahí la descripción "prácticamente RESTful"). Fomenta la reutilización, permite el descubrimiento y el intercambio de patrones y tiene como objetivo el surgimiento de mejores prácticas basadas en el mérito.[2]​

La gran ventaja de implementar API con RAML es poder centrarse totalmente en el "contrato" que ofrece el endpoint; esto permite comenzar generando la documentación, para la cual, una vez esté lista, existen distintos generadores que crearán el "scaffolding" o esqueleto básico del servicio, e incluso servicios que devuelvan respuestas simuladas para empezar con las pruebas. Esta metodología favorece el proceso de testing aportando el entorno perfecto para usar TDD (Desarrollo guiado por pruebas). Básicamente, se define la API, se estiman tests para consumir esa API y se empieza a construir la implementación real y necesaria para validar tanto los test como la especificación descrita.

Historia

[editar]

La especificación RAML se propuso por primera vez en 2013 por Uri Sarid, Emiliano Lesende, Santiago Vacas y Damian Martinez. Además, obtuvo el apoyo de líderes tecnológicos como MuleSoft, AngularJS, Intuit, Box, PayPal, Programmable Web y API Web Science, Kin Lane, SOA Software y Cisco.[3]​ El desarrollo fue gestionado por el grupo de trabajo RAML.

Los firmantes del grupo de trabajo actual incluyen los siguientes líderes tecnológicos:

  • MuleSoft (Uri Sarid, CTO)
  • AngularJS (Misko Hevery, Fundador del proyecto)
  • Intuit (Ivan Lazarov, Arquitecto jefe de la empresa)
  • Airware (Peter Rexer, Director de Producto - Plataforma de desarrollo)
  • Programmable Web and API Science (John Musser, Fundador)
  • SOA Software (Tony Gullotta, director de desarrollo)
  • CISCO (Jaiddep Subedar, Senior Manager, Product Management - Application Integration Solutions Group)
  • VMware (Kevin Duffey, Senior MTS Engineer)
  • Akamai Technologies (Rob Daigneau, Director de arquitectura de la plataforma OPEN API de Akamai)
  • Restlet (Jerome Louvel, director de tecnología y fundador)

RAML es una marca comercial de MuleSoft.[4]​

Muy pocas APIs existentes cumplen los criterios precisos para ser clasificadas como API RESTful. En consecuencia, como la mayoría de las iniciativas de API en la década de 2010, RAML se ha centrado inicialmente en los conceptos básicos de la APIs prácticamente RESTful, incluidos recursos, métodos, parámetros y cuerpos de respuesta que no necesitan ser hipermedia. Hay planes para avanzar hacia API RESTful más estrictas a medida que la evolución de la tecnología y el mercado lo permitan.

En estos puntos se verá por qué RAML es interesante para la comunidad de API:[5]​

  • RAML es de código abierto junto con herramientas y analizadores para lenguajes comunes. El desarrollo de RAML está supervisado por un comité directivo de profesionales de API y UX, y existe un ecosistema emergente de herramientas de terceros que se están desarrollando en torno a RAML.[6]​
  • MuleSoft originalmente comenzó a usar Swagger (ahora especificación OpenAPI), pero decidió que era más adecuado para documentar una API existente, no para diseñar una API desde cero. RAML evolucionó a partir de la necesidad de admitir el diseño de API por adelantado en un lenguaje sucinto y centrado en el ser humano.[7]​
  • Las descripciones de las APIs suelen ser detalladas y repetitivas, lo que puede dificultar su comprensión y uso, y hacer que la adopción de la API sea más lenta. RAML ha introducido características de lenguaje que admiten archivos estructurados y herencia que abordan preocupaciones transversales.[8]​

Una nueva organización, bajo el patrocinio de la Fundación Linux, llamada OpenAPI Initiative se estableció en 2015 para estandarizar la descripción de las API RESTful. Varias empresas, incluidas SmartBear, Google, IBM y Microsoft, fueron miembros fundadores.[9]​[10]​ SmartBear donó la especificación Swagger al nuevo grupo. El grupo también está considerado RAML y API Blueprint.[11]​[12]​

Código de ejemplo

[editar]

RAML permite el desarrollo rápido de una API utilizando una sintaxis accesible que puede escalar desde un pequeño proyecto hasta una aplicación empresarial.

#%RAML 1.0
title: Mobile Order API
baseUri: http://localhost:8081/api
version: 1.0

uses:
  assets: assets.lib.raml

annotationTypes:
  monitoringInterval:
    type: integer

/orders:
  displayName: Orders
  get:
    is: [ assets.paging ]
    (monitoringInterval): 30
    description: Lists all orders of a specific user
    queryParameters:
      userId:
        type: string
        description: use to query all orders of a user
  post:
  /{orderId}:
    get:
      responses:
        200:
          body:
            application/json:
              type: assets.Order
            application/xml:
              type: !include schemas/order.xsd

Partes del código a destacar:

  • Líneas 2-4: Nombre de la API, especificación de versión y URL base.
  • Líneas 9-11: Especificación de los tipos de reutilizables para evitar duplicaciones y redundancias
  • Líneas 13-22: Modelación de los endpoints con información de acceso, métodos de HTTP y parámetros.
  • Líneas 29-32: Modelación de los múltiples tipos de respuesta, incluidos JSON y XML, dentro de una sola interfaz.

Puertas de enlace API que admiten RAML

[editar]

Además, puede convertir su especificación RAML a OpenAPI o API Blueprint utilizando APIMATIC, lo que permite utilizar más puertas de enlace API.

Véase también

[editar]

Lenguajes alternativos de modelado RESTful

[editar]

Referencias

[editar]
  1. ↑ «RAML 1.0». Consultado el 9 de mayo de 2021. 
  2. ↑ «RAML - Lenguaje de modelado de API RESTful». Consultado el 9 de mayo de 2021. 
  3. ↑ «RAML o OpenAPI - ¿Qué tal ambos? - Integración DZone». Consultado el 9 de mayo de 2021. 
  4. ↑ «RAML - Detalles de la marca registrada». Consultado el 9 de mayo de 2021. 
  5. ↑ «Por qué RAML es más que otra especificación patentada». Consultado el 9 de mayo de 2021. 
  6. ↑ «Herramientas de diseño de API de RAML». Consultado el 9 de mayo de 2021. 
  7. ↑ «Anypoint para API: una entrevista con Uri Sarid». Consultado el 9 de mayo de 2021. 
  8. ↑ «Ejemplo de diseño de API usando RAML». Consultado el 9 de mayo de 2021. 
  9. ↑ «SmartBear, la Fundación Linux lanza la iniciativa de API abierta para evolucionar Swagger». Consultado el 9 de mayo de 2021. 
  10. ↑ «Nuevo proyecto colaborativo para ampliar la especificación Swagger para la construcción de aplicaciones y servicios conectados». Archivado desde el original el 27 de abril de 2016. Consultado el 9 de mayo de 2021. 
  11. ↑ «En 2016, cristalizará la necesidad de un metalenguaje API». Consultado el 9 de mayo de 2021. 
  12. ↑ «Amazon API Gateway ahora admite la importación de definiciones Swagger». Consultado el 9 de mayo de 2021. 

Enlaces externos

[editar]
Obtenido de «https://es.wikipedia.org/eswiki/w/index.php?title=RAML_(lenguaje)&oldid=162732316»