API-Rest-con-OpenAPI-y-OData.md

+# API Rest
+La aplicación soporta dos modelos de API Rest. Uno basado en el estándar OpenAPI (con Swagger) y otro basado en OData.
+
+Ambos modelos definen estándares independientes del lenguaje de programación y ofrecen un API Rest. Este APIpermite que tanto humanos como sistemas electrónicos descubran y comprendan las capacidades del servicio sin acceder al código fuente, documentación o mediante inspección del tráfico de red. Cuando se define correctamente, un consumidor puede comprender e interactuar con el servicio remoto con una cantidad mínima de lógica de implementación.
+
+OpenAPI y OData son dos tecnologías diferentes, aunque a menudo pueden utilizarse en conjunto para crear APIs robustas y interoperables. OpenAPI se utiliza para describir y documentar APIs RESTful, mientras que OData se utiliza para estandarizar la forma en que se exponen y consumen datos a través de APIs RESTful, proporcionando características específicas para consultas de datos. A menudo, se pueden utilizar juntas para crear APIs completas y bien documentadas que proporcionen acceso a datos de manera uniforme y estructurada.
+
+A continuación se describen estos protocolos y cómo usarlos con Star2127.
+
+## OpenAPI
+La especificación OpenAPI define un estándar independiente del idioma para las API Rest que permite que tanto humanos como computadoras descubran y comprendan las capacidades del servicio sin acceso al código fuente, documentación o mediante inspección del tráfico de red. Cuando se define correctamente, un consumidor puede comprender e interactuar con el servicio remoto con una cantidad mínima de lógica de implementación.
+
+Jmix REST proporciona documentación de API generada automáticamente en el formato de Especificación OpenAPI. Se puede utilizar la documentación de la API para visualizar, probar o generar código cliente para la API REST utilizando herramientas como Postman o Swagger.
+
+En la web de JMIX se puede ampliar su funcionamiento: https://docs.jmix.io/jmix/rest/getting-started.html
+
+Por defecto, los puntos finales requieren autenticación pero durante la fase de desarrollo se ha previsto que el acceso sea anónimo. Para cambiar esta carácterística es necesario tocar el fichero de propiedades y cambiar la línea que pone 
+```
+jmix.rest.anonymous-url-patterns = /rest/docs/*
+```
+
+
+## OData
+OData (Open Data Protocol) es un protocolo de comunicación web estándar que permite la creación y el consumo de servicios web basados en datos. Inicialmente fue desarrollado por Microsoft. En la actualidad está respaldado por un amplio consorcio de empresas. OData se basa en estándares web existentes como HTTP, JSON y AtomPub para proporcionar una forma uniforme y estandarizada de exponer y consumir datos a través de la web.
+
+PENDIENTE: terminar de explicar el funcionamiento y cómo se ha integrado. Completar la documentación.
\ No newline at end of file