![Open API Open API](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjRUaDtrttlLnu4O7bfuMZ3lSVPlKBkUULhmw0-h_tVlZJdSOESgJnwna2_5fz3PbQ2uHotYF6uM8_eTdvQ8goeR5-zZfBUw2QtleNRMTz7RNSf8QrvyEYbs9D1iBjB5hq4A7C92Q/s1600/open-api.png)
![Descripción OpenAPI de una API](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgD0TbN5BZ1ocD6_jp1mfd4Yq8HFxOILmLufZM45SCom925d5GyWTtSZ_wHYCqsgz3VLkAElv0rLHPjngHT9yO3LSPMLHb-cqh0zeeTKLt8MdKl8v6VVjjAMRDJ8GtrCd5qKx0Zzw/s1600/swashbuckle.png)
En este post vamos a ver un par de formas de sacar provecho de esta descripción:
- En primer lugar, usaremos Swagger UI para generar un sitio web interactivo de documentación y pruebas de nuestra API.
- Después, veremos cómo generar desde Visual Studio código cliente para acceder a la API.
Publicado por José M. Aguilar a las 8:05 a. m.
Etiquetas: aspnetcore, aspnetcoremvc, openapi, swagger, webapi
![Open API Open API](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjRUaDtrttlLnu4O7bfuMZ3lSVPlKBkUULhmw0-h_tVlZJdSOESgJnwna2_5fz3PbQ2uHotYF6uM8_eTdvQ8goeR5-zZfBUw2QtleNRMTz7RNSf8QrvyEYbs9D1iBjB5hq4A7C92Q/s1600/open-api.png)
El objetivo de OpenAPI es conseguir una fórmula normalizada para describir las capacidades de un servicio REST, independientemente de los lenguajes o tecnologías con las que sea implementado. Esta descripción, normalmente especificada en formato JSON o YAML, permite a clientes (sean humanos o máquinas) descubrir servicios, comprender sus capacidades y conocer sus detalles de funcionamiento sin necesidad de tener acceso a su código fuente o documentación textual.
Esta especificación formal abre interesantes posibilidades, pues a partir de la definición estandarizada de servicios es posible, entre otros,
- disponer de herramientas de diseño y modelado de servicios,
- generar automáticamente páginas de documentación,
- generar automáticamente código cliente y servidor para dichos servicios para distintos, frameworks y lenguajes de programación,
- generar automáticamente código de testing y validaciones,
- o generar automáticamente mocks de servicios.
Publicado por José M. Aguilar a las 8:05 a. m.
Etiquetas: aspnetcore, aspnetcoremvc, openapi, swagger, webapi