Te damos la bienvenida a la base de conocimiento de OpenAPI #

Te damos la bienvenida a la base de conocimiento de OpenAPI, tu recurso único para todo lo relacionado con la especificación OpenAPI (OAS). Tanto si eres un desarrollador con experiencia, un redactor técnico o alguien que se inicia en el diseño de API, este sitio web te ofrece información completa y actualizada, además de herramientas, para que aproveches todo el potencial de OpenAPI.

¿Qué es OpenAPI? #

OpenAPI, también conocido como especificación OpenAPI (OAS), es una especificación estándar para definir API RESTful. Permite a los desarrolladores describir la estructura de sus API en un formato legible por máquinas, de modo que tanto las personas como los equipos informáticos puedan comprender las capacidades y funcionalidades de la API sin necesidad de acceder directamente al código fuente. OpenAPI desempeña un papel fundamental en el desarrollo de API: estandariza el proceso de documentación, facilita las pruebas de las API y mejora la interoperabilidad en general.

Explora nuestros recursos #

Primeros pasos #

Si eres nuevo en OpenAPI, nuestra sección Primeros pasos es el lugar perfecto para empezar. Aquí encontrarás guías introductorias que cubren los fundamentos de OpenAPI, entre ellas:

• Introducción a OpenAPI: Conoce la historia, el propósito y las características principales de OpenAPI.
• Cómo crear tu primer documento OpenAPI: Instrucciones paso a paso para ayudarte a crear tu primer documento OpenAPI.
• Conceptos básicos y terminología: Familiarízate con los términos y conceptos esenciales del ecosistema OpenAPI.

Guías completas #

Si buscas profundizar en tus conocimientos, nuestra sección Guías completas ofrece explicaciones detalladas y ejemplos sobre una amplia variedad de temas, como:

• Características avanzadas de OpenAPI: Adéntrate en los aspectos más complejos de OpenAPI, como el polimorfismo, los callbacks y los links.
• Buenas prácticas para el diseño de API: Aprende a diseñar API que sean fáciles de usar y de mantener.
• Documentación y anotación: Descubre las mejores formas de documentar tu API para garantizar claridad y facilidad de uso.

OpenAPI Overlays #

La especificación OpenAPI Overlay te permite personalizar o ampliar un documento OpenAPI sin editar su origen, lo que resulta ideal para publicar documentación adaptada a cada audiencia, ocultar endpoints internos o automatizar cambios en CI/CD. Empieza con:

• ¿Qué es la especificación OpenAPI Overlay?: Los conceptos fundamentales, la estructura del documento y las acciones disponibles.
• Cómo usar OpenAPI Overlays: Un recorrido práctico por todas las opciones de overlay con ejemplos de código.
• Decenas de guías específicas por tarea que abarcan ocultación de contenido, localización, generación de SDK, control de versiones y más están disponibles en la sección de guías prácticas.

Herramientas e integraciones #

OpenAPI cuenta con el respaldo de un amplio ecosistema de herramientas e integraciones que amplían su funcionalidad. En nuestra sección Herramientas e integraciones encontrarás información sobre:

• Herramientas de diseño de API: Explora las herramientas más populares para diseñar y editar documentos OpenAPI, como Swagger Editor y Stoplight.
• Pruebas y validación: Conoce las herramientas que te ayudan a probar y validar tus API para asegurarte de que cumplan con las especificaciones requeridas.
• Generación de código: Descubre cómo generar bibliotecas de cliente, stubs de servidor y documentación de API a partir de tus documentos OpenAPI.

Comunidad y soporte #

La comunidad de OpenAPI es dinámica y acogedora. Tanto si tienes una pregunta, quieres participar o buscas conectar con otros entusiastas de OpenAPI, aquí te indicamos adónde acudir:

• Referencia «¿Qué es…?» de OpenAPI: Respuestas rápidas y concretas a las preguntas más habituales del tipo «¿qué es…?» sobre términos, objetos y especificaciones relacionadas con OpenAPI.
• Guías prácticas: Soluciones paso a paso para tareas concretas, desde escribir tu primer documento hasta flujos de trabajo avanzados con overlays.
• ¿Cómo puedo contribuir a la comunidad de OpenAPI? y ¿Cómo puedo contribuir a la especificación OpenAPI?: Formas prácticas de participar, desde las discusiones en GitHub hasta la documentación y las herramientas.
• ¿Cómo puedo unirme a la OpenAPI Initiative? y ¿Quiénes son los miembros de la OpenAPI Initiative?: Conoce cómo funciona la membresía y qué organizaciones impulsan el avance de la especificación.

Para una participación directa, el repositorio de GitHub de la especificación OpenAPI y su foro de Discussions son los principales puntos de encuentro para las conversaciones técnicas, mientras que el sitio web de la OpenAPI Initiative es la fuente oficial de información sobre gobernanza y programas.

Mantente al día #

La especificación OpenAPI se mantiene de forma activa, y OpenAPI 3.2.0 es la última versión publicada (consulta ¿Cuál es la última versión de la especificación OpenAPI? para más detalles). Mantente informado a través de:

• ¿Cómo puedo mantenerme al día con las noticias y novedades de OpenAPI?: Una guía de los canales que vale la pena seguir.
• ¿Cómo puedo participar en los eventos de OpenAPI? y ¿Cuáles son los próximos eventos de OpenAPI?: Conferencias, meetups y webinars recurrentes que puedes añadir a tu calendario.
• El blog de la OpenAPI Initiative y su calendario de eventos, con anuncios y eventos programados.
• GitHub Releases, con los registros de cambios de cada versión publicada de la especificación.

Empieza a explorar #

Te invitamos a explorar el Centro de documentación de OpenAPI para encontrar respuestas a tus preguntas y descubrir nuevas formas de aprovechar al máximo la especificación OpenAPI. Tanto si quieres empezar con tu primera API, mejorar las que ya tienes o simplemente aprender más sobre el diseño de API, aquí encontrarás información y recursos valiosos.

¡Feliz diseño de API!