API Docs

Todos los documentos relacionados con sus API, que se exhiben en Products, se enumeran aquí en API Docs.

Aquí le mostramos cómo:

  • Agregar documentación manualmente.

    La carga manual es opcional, ya que la documentación se carga automáticamente cuando se importa la API.

  • Editar y eliminar (cuando la documentación se ha agregado manualmente).

  • Ver.

  • Ejecutar llamadas de ejemplo a la API (api-settings.adoc#try-out[tryout]), directamente desde la documentación.

Lista de API Docs

La lista de API Docs muestra:

  • Vendor: indicado por los iconos: icono de Sensedia (Sensedia) y icono de AWS (AWS);

  • API Name: nombre de API, como registrado en la plataforma;

  • Version: versión de la API;

  • Last revision: última revisión de la API;

  • Availability: informa si la API está disponible para mostrarse en el navegador y ser utilizada por una APP;

  • Actions: desde esta columna, puede editar, eliminar y visualizar la documentación haciendo clic en el icono respectivo.

captura de la pantalla api docs

Los iconos de acción para editar (icono con la imagen de un lápiz) y eliminar (icono con la imagen de una papelera) no están disponibles para la documentación que se agregó automáticamente con la importación de API.

Búsqueda

El campo de búsqueda se encuentra justo encima de la lista de API Docs.

Puede buscar la documentación por nombre de API y ordenar el resultado en orden ascendente o descendente.

Carga manual

Para agregar documentación manualmente, siga los pasos a continuación:

  1. En API Docs, haga clic en el botón + NEW API DOCS.

  2. En la siguiente pantalla, haga clic en el botón UPLOAD YOUR FILE, ubicado en la parte inferior izquierda de la pantalla.

  3. Explore su administrador de archivos y seleccione el archivo .yaml o .json deseado.
    Puede cargar un archivo a la vez.

  4. El archivo seleccionado se mostrará en la pantalla. Haga clic en SAVE para guardar o REPLACE FILE para elegir otro archivo.

pasos para agregar nueva documentación manualmente

Como resultado de estos pasos, la documentación se cargará y se mostrará en la lista de API Docs.

Visualización

Para ver y comprobar su documentación, siga los siguientes pasos:

  1. En API Docs, haga clic en el icono icono en forma de ojo.

  2. La siguiente pantalla mostrará la última versión de Swagger o OpenAPI. Si hay versiones anteriores, aparecerán en la parte superior de la pantalla. Seleccione la versión que desea ver.

Como resultado de estos pasos, la documentación se cargará y se mostrará en la pantalla.

Edición de documentación

Para cambiar la documentación, reemplace el archivo con la nueva versión. Siga los siguientes pasos:

  1. En API Docs, haga clic en el icono icono en forma de lápiz.

  2. En la siguiente pantalla, desplácese hasta el final de la página y haga clic en el botón REPLACE FILE.

  3. Explore el administrador de archivos de su sistema operativo y seleccione el archivo .yaml o .json deseado.
    Puede cargar un archivo a la vez.

  4. Haga clic en el botón SAVE para guardar o SAVE AS NEW VERSION para guardar como una nueva versión.

Sólo se puede editar la documentación que se ha añadido manualmente.

Eliminar una documentación

Para eliminar una documentación, siga los pasos que se indican a continuación:

  1. En API DOCS, haga clic en icono en forma de papelera.

  2. En la pantalla siguiente, haga clic en DELETE para confirmar.

Sólo puede eliminarse la documentación que se haya añadido manualmente.
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]