¿Cómo usar Swagger?

Swagger es un lenguaje de descripción de interfaz que describe las API RESTful expresadas mediante JSON. Le permite crear API documentationinteractivas, legibles por máquinas y por humanos. Le 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. Abra el sitio de documentación de Swagger.

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

3. Introduzca el token de API en el campo Valor .

   NOTA

   Puede seleccionar un token existente o puede generar un nuevo token según sus requisitos. Para generar un nuevo token, siga los pasos a continuación

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

   • En el panel de navegación izquierdo, vaya a Portal de la base de conocimientos > tokens de API.

   • Escriba un nombre para el token de API en Escriba el nombre del token.

   • Seleccione los métodos HTTP necesarios. Tiene cuatro métodos en Método(s) permitido(s): GET, PUT, POST y DELETE.

   • Solo puede usar el token generado para los métodos seleccionados. No se puede utilizar para realizar otros métodos.

   • Haga clic en Copiar para copiar el token de API.

4. Haga clic en el botón Autorizar .

5. Una vez hecho esto, haga clic en el botón Cerrar .
   La autorización se realiza correctamente.

   

   NOTA

   Si desea cambiar a un token diferente, haga clic en Autorizar > Cerrar sesión > ingrese su token de API > Autorizar > Cerrar.

OBTENER

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

• A continuación se muestra un ejemplo de acción GET para recuperar todos los registros sobre la cuenta del equipo.

1. Rellene los campos marcados y haga clic en el botón Ejecutar .

   La información sobre la cuenta del equipo estará disponible en la sección Respuestas .

EXPONER

• El método POST se usa para agregar un elemento.

• A continuación se muestra un ejemplo de una acción POST , para agregar una cuenta de equipo a un proyecto.

1. Debe agregar la información de la cuenta del equipo, como email_id, first_name y last_name para agregar un usuario al proyecto.
   La cuenta de equipo se agregará al proyecto.

2. Haga clic en el botón Ejecutar .
   La adición de la cuenta de equipo se realizará correctamente si el estado es 200 y el éxito es verdadero.

PONER

• El método PUT se usa 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. Introduzca el userId en el campo marcado.

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

   • 1 → Administrador

   • 2 Editor →

   • 3 → Redactor de borradores

   • 4 → Lector

   • 7 → Propietario

3. Una vez hecho esto, haga clic en el botón Ejecutar .

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

BORRAR

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

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

1. Introduzca el userId en el campo marcado.

2. Una vez hecho esto, haga clic en el botón Ejecutar .
   Si el estado es 200 y el éxito es true, el userId se eliminará correctamente.

   

NOTA

Es obligatorio introducir el contenido en el campo que están marcados como *obligatorios.

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

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

2. Feature spotlight – API in Document360