Cómo usar Swagger

Swagger es un lenguaje de descripción de interfaces que describe APIs RESTful expresadas usando JSON. Te permite crear documentación interactiva, legible por máquinas y por humanos. Te ayuda a visualizar e interactuar con los recursos de la API sin ninguna lógica de implementación. Es una aplicación basada en la web.

Sitio de documentación de Swagger

1. Abre el sitio de documentación de Swagger.

2. Para autenticar la documentación, haz clic en Autorizar.
   Aparecerá el panel de Autorizaciones disponibles .

3. Introduce el token API en el campo Valor .

   NOTA

   Puedes seleccionar un token existente, o generar un nuevo token según tus necesidades. Para generar un nuevo token, sigue los siguientes pasos

   • Navega a Configuración () en la barra de navegación izquierda del portal de la Base de conocimientos.

   • En el panel de navegación izquierdo, navega al Portal de la base de conocimientos > Tokens de API.

   • Escribe un nombre para el token API en el nombre del token Introducir.

   • Seleccione el(los) método(s) HTTP requeridos. Tienes cuatro métodos en Permitido(s): GET, PUT, POST y DELETE.

   • Solo puedes usar el token generado para el/los método(s) seleccionado(s). No puede usarse para realizar otros métodos.

   • Haz clic en Copiar para copiar el token de la API.

4. Haz clic en el botón Autorizar .

5. Cuando termines, haz clic en el botón Cerrar .
   La autorización se realiza con éxito.

   

   NOTA

   Si deseas cambiar a otro token, haz clic en Autorizar > cerrar sesión > introduce tu token API > Autorizar > Cierre.

GET

• El método GET se utiliza para recuperar información.

• A continuación se muestra un ejemplo de la acción GET , para recuperar todos los registros sobre el usuario.

1. Rellena los campos marcados y haz clic en el botón Ejecutar .

   La información sobre el usuario estará disponible en la sección de Respuestas .

PUBLICACIÓN

• El método POST se utiliza para añadir un elemento.

• A continuación se muestra un ejemplo de una acción POST , para añadir un usuario a un proyecto.

1. Deberías añadir la información de usuario como email_id, first_name y last_name para añadir un usuario al proyecto.
   El usuario será añadido al proyecto.

2. Haz clic en el botón Ejecutar .
   La incorporación del usuario será exitosa si el estado es 200 y el éxito es cierto.

PUT

• El método PUT se utiliza para actualizar un elemento existente.

• A continuación se muestra un ejemplo de acción PUT , para actualizar un rol de usuario en el proyecto.

1. Introduce el userId en el campo marcado.

2. Actualiza el rol de usuario con el número mencionado para la sintaxis del rol de usuario. Los números para los respectivos roles son los siguientes:

   • 1 → Administrador

   • 2 → Editor

   • 3 → redactor de borradores

   • 4 → Reader

   • 7 → Propietario

3. Cuando termines, haz clic en el botón Ejecutar .

   La actualización del usuario es exitosa si el estado es 200 y el éxito es cierto.

BORRAR

• El método DELETE se utiliza para eliminar un elemento.

• A continuación se muestra un ejemplo de una acción DELETE , para eliminar un userId.

1. Introduce el userId en el campo marcado.

2. Cuando termines, haz clic en el botón Ejecutar .
   Si el estado es 200 y el éxito es cierto, el userId será eliminado con éxito.

   

NOTA

Es obligatorio introducir el contenido en el campo marcado como *requerido.

 Para más información, consulte los siguientes blogs

1. Guía definitiva para crear una documentación de API con ejemplos

2. Destacado de funciones – API en Document360