Hispanopedia WikiLos lenguajes de descripción ( DL ) de API (interfaz de programación de aplicaciones) RESTful (transferencia de estado representacional) son lenguajes formales diseñados para proporcionar una descripción estructurada de una API web RESTful que sea útil tanto para un ser humano como para el procesamiento automático de máquinas. Los lenguajes de descripción de API a veces se denominan lenguajes de descripción de interfaz (IDL). La descripción estructurada se puede utilizar para generar documentación para programadores humanos ; dicha documentación puede ser más fácil de leer que la documentación de formato libre, ya que toda la documentación generada por la misma herramienta sigue las mismas convenciones de formato. Además, el lenguaje de descripción suele ser lo suficientemente preciso como para permitir la generación automatizada de varios artefactos de software, como bibliotecas, para acceder a la API desde varios lenguajes de programación, lo que quita la carga de crearlos manualmente a los programadores. [1]
Historia
Existen dos lenguajes de descripción principales: WSDL 2.0 (lenguaje de descripción de servicios web) y WADL (lenguaje de descripción de aplicaciones web). Ninguno de ellos se ha adoptado ampliamente en la industria para describir API RESTful, debido a la poca legibilidad humana de ambos y a que WADL no es capaz de describir completamente una API RESTful. [2]
Principio
API basada en hipertexto
El principio detrás de la creación de APIs RESTful se conoce con el acrónimo HATEOAS ( Hypermedia as the Engine of Application State ). En este enfoque, el software del cliente no se escribe en una descripción de interfaz estática compartida a través de documentación. En su lugar, se le proporciona al cliente un conjunto de puntos de entrada y la API se descubre dinámicamente a través de la interacción con estos puntos finales. HATEOAS se introdujo en la tesis doctoral de Roy Fielding Architectural Styles and the Design of Network-based Software Architectures . HATEOAS es uno de los elementos clave que distinguen a REST de los mecanismos RPC . [3]
Lista de DL de API RESTful
- Lenguaje de descripción de servicios web (WSDL)
- Hidra
- Protocolo de datos abiertos (OData)
Referencias
- ^ Zhai, Juan; Huang, Jianjun; Ma, Shiqing; Zhang, Xiangyu; Tan, Lin; Zhao, Jianhua; Qin, Feng (14 de mayo de 2016). "Generación automática de modelos a partir de la documentación para funciones de la API de Java". Actas de la 38.ª Conferencia Internacional sobre Ingeniería de Software . ICSE '16. Nueva York, NY, EE. UU.: Association for Computing Machinery. págs. 380–391. doi :10.1145/2884781.2884881. ISBN 978-1-4503-3900-1. Número de identificación del sujeto 2733669.
- ^ Fielding, Roy. "Las API REST deben estar basadas en hipertexto" . Consultado el 4 de noviembre de 2015 .
