Muestra las diferencias entre dos versiones de la página.
Ambos lados, revisión anterior Revisión previa Próxima revisión | Revisión previa | ||
ada:howto:sicoferp:factory:goodsoftwaredevelopmentpractices:doc [2023/11/06 20:31] 192.168.177.82 |
ada:howto:sicoferp:factory:goodsoftwaredevelopmentpractices:doc [2023/11/07 15:55] (actual) 192.168.175.10 [¿Que es OpenAPI?] |
||
---|---|---|---|
Línea 14: | Línea 14: | ||
==== ¿Que es OpenAPI? ==== | ==== ¿Que es OpenAPI? ==== | ||
- | OpenAPI es el estándar global para escribir APIs RESTful. Es como una especificación que permite a los desarrolladores de todo el planeta estandarizar el diseño de sus APIs. | + | OpenAPI es el estándar global para escribir APIs RESTful. Es una especificación que permite a los desarrolladores estandarizar el diseño de sus APIs. |
- | Además, cumple con toda la seguridad, el versionado, el manejo de errores y otras mejores prácticas al escribir APIs REST desde cero. Y no sólo desde el principio, sino que incluso las APIs existentes pueden ajustarse para cumplir con un estándar global((https://codigoencasa.com/openapi/)). | + | Además, cumple con toda la seguridad, el versionado, el manejo de errores y mejores prácticas al escribir APIs REST desde cero. Y no sólo desde el principio, sino que incluso las APIs existentes pueden ajustarse para cumplir con un estándar global((https://codigoencasa.com/openapi/)). |
La especificación OpenAPI es un lenguaje de especificación para API HTTP que proporciona un medio estandarizado para definir su API ante otros. Podemos descubrir rápidamente cómo funciona una API, configurar la infraestructura, generar código de cliente y crear casos de prueba. [[https://www.openapis.org/|Para mas información -> Ir al sitio web oficial.]] | La especificación OpenAPI es un lenguaje de especificación para API HTTP que proporciona un medio estandarizado para definir su API ante otros. Podemos descubrir rápidamente cómo funciona una API, configurar la infraestructura, generar código de cliente y crear casos de prueba. [[https://www.openapis.org/|Para mas información -> Ir al sitio web oficial.]] | ||
Línea 47: | Línea 47: | ||
==== Configuración de opciones en el archivo de configuración (.properties/.yaml) ==== | ==== Configuración de opciones en el archivo de configuración (.properties/.yaml) ==== | ||
+ | Se deben adicionar las siguientes propiedades para activar la generación y visualización de la documentación. | ||
- | <code yaml> | + | <code properties> |
#***************************************************************************** | #***************************************************************************** | ||
#OpenAPI Configuration | #OpenAPI Configuration |