Bien, en la
pantalla, tengo la cuenta de GitHub para la especificación OpenAPI.
Aquí es donde se encuentra todo el código fuente de la OpenAPI.
Vive dentro de este repositorio de GitHub.
Proporcionaré un enlace a esto en los recursos del curso para que puedas ir directamente aquí.
Ahora hay algunas cosas que quiero señalar aquí específicamente para el
curso que vamos a echar un vistazo. Si vienes aquí y echa un vistazo a los ejemplos de directorio dentro de GitHub puede
ver que tenemos la versión 2. 0 y 3. 0.
De nuevo no me estoy centrando en la 2. 0 pero voy a estar buscando en 3. 0.
He aquí algunos ejemplos.
Recuerde que nos fijamos en petstore así que aquí está el petstore. YAML cuenta con la especificación OpenAPI.
Puedes ver que hay varias implementaciones diferentes de la especificación OpenAPI que podemos mirar.
Así que algunos ejemplos muy buenos cuando se necesita para ver cómo hacer algo que
usted puede ir a través y revisar estos y vamos a volver aquí. A continuación, lo siguiente que queremos echar un vistazo aquí es este IMPLEMENTACIONES
este archivo markdown aquí IMPLEMENTACIONES. Estas son las implementaciones conocidas para OpenAPI3. 0.
Podemos ver que hay una serie de herramientas que se han configurado en diferentes programas que están disponibles.
Esta lista no deja de crecer. Recomiendo encarecidamente echarle un vistazo y hay diferentes tecnologías
disponibles.
Soy principalmente un desarrollador Java, por lo que puedes ver una serie de herramientas Java allí.
Apenas sé deletrear Ruby pero hay herramientas Ruby, Node. js, Typescript, PHP. Así que disponemos de un gran número
de herramientas.
Recuerda que he dicho que vamos a utilizar el editor SwaggerHub.
Estas son algunas herramientas específicas para trabajar con OpenAPI.
Algunos editores específicos. A mucha gente le gusta Visual Studio.
En realidad he utilizado este aquí en la parte superior Visual Studio Code extensión es bastante agradable. Así que quizá prefieras utilizar Sisual
Studio.
Es una herramienta gratuita que es una editorial que puedes utilizar.
Y de hecho sé de algunos que no están disponibles aquí, así que esta no es una lista completa de ninguna manera, en realidad
hay herramientas adicionales que no están en esta lista.
A continuación, puede ver aquí Interfaces de usuario.
Así que estas son herramientas que vamos a tomar en la especificación OpenAPI y le dará la documentación.
Así que ya hemos visto a swagger-ui en acción.
Y aquí tienes algunas opciones adicionales.
Así que Widdershins que es un muy popular.
En cuanto a generar documentación para el usuario final a partir de su especificación OpenAPI, personalmente me gusta bastante
Redoc.
Esta es una herramienta muy agradable para generar y documentación de usuario de su especificación OpenAPI y ahora también se
puede ver que tenemos implementaciones de servidor, implementaciones de cliente, generadores de código.
Así que hay una serie de diferentes generadores de código que puede utilizar con la especificación OpenAPI.
Volvamos aquí.
Y recuerda que he dicho que la especificación OpenAPI está respaldada por un esquema formal.
Este es el esquema JSON.
Si quieres ir a través y ver exactamente, aquí
es donde realmente se puede echar un vistazo a cómo se define el esquema OpenAPI este es el código fuente en bruto para que, por así decirlo, pero
vamos a ver esto a través de un enfoque diferente. No voy a profundizar demasiado en que
es volver por aquí y, finalmente, recomiendo encarecidamente ir a través de esta documentación que hay una
gran cantidad de documentación a este.
Puedes ver herramientas y librerías participación cómo se licencia si quieres contribuir a este proyecto es
un proyecto de código abierto.
Así que incluso tienen un comité de dirección técnica el desarrollo de directrices por lo que el lote aquí, obviamente,
no voy a ir a través de cada cosa que sólo estamos hablando de tratar de llegar a OpenAPI y se puede ver aquí
que estamos actualmente en 3. 0. 2.
Y si hago clic a esto, este enlace en realidad me va a llevar en dos versiones.
Así que voy a seguir adelante y hacer clic en esto.
Esta es la documentación para el esquema OpenAPI y vamos a familiarizarnos con él.
Específicamente vamos a estar viendo el desarrollo contra el esquema OpenAPI y vamos
a estar viendo lo específico como el objeto OpenAPI. Puedes ver aquí que esta es la especificación del esquema de nivel superior
y vamos a ir a través de esto en los próximos videos.
Esta documentación aquí para OpenAPI es muy rica es muy detallada y usted debe considerar este documento y la única
fuente de verdad para cuando usted está trabajando con la documentación OpenAPI.