1. Home
  2. Documentation
  3. Guía de uso de Sensedia Docs
  4. Uso de Open API

Uso de Open API

Guía sobre cómo usar Open API

Open API es una especificación que permite describir APIs RESTful de forma estandarizada. Facilita la comprensión y el uso de las APIs, además de permitir la generación automática de documentación y código cliente. Sensedia Docs ofrece soporte para crear documentación de APIs usando Open API, permitiendo que describas tus endpoints, parámetros, respuestas y otros detalles de forma clara y estructurada.

Creando una documentación Open API

Para crear una documentación Open API en Sensedia Docs, puedes seguir los siguientes pasos:

Añade un nuevo documento

Puedes crear un nuevo documento .json y referenciarlo en tu proyecto, o enlazar un documento Open API remoto.

Referencia el documento Open API

Dentro del archivo .md, utiliza el componente OpenAPI para referenciar el documento Open API. Por ejemplo:

o

Visualiza la documentación

Después de añadir el componente, puedes visualizar la documentación Open API directamente en Sensedia Docs. La documentación se renderizará automáticamente, mostrando los detalles de los endpoints, parámetros, respuestas y otros aspectos de la API.

Ejemplo de uso local

¿Qué tan satisfecho estás con esta página?

Nuestro sitio web utiliza cookies para habilitar funcionalidades básicas de evaluación y notificaciones. No utilizamos cookies de seguimiento para publicidad ni análisis de terceros.Aprender más