--- title: "Cómo usar Swagger" slug: "how-to-use-swagger" updated: 2026-07-01T04:57:23Z published: 2026-07-01T04:57:23Z canonical: "docs.document360.com/how-to-use-swagger" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.document360.com/llms.txt > Use this file to discover all available pages before exploring further. # 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](https://apihub.document360.io/). 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** . > [!NOTE] > 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. ![Image showing authorize panel in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/17_ScreenShot-Swagger.png) > [!NOTE] > 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. ![Image showing GET action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/12_ScreenShot-Swagger_Get.png) 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** . ![Image showing GET action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/13_ScreenShot-Swagger_Get.png) ### 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. ![Image showing POST action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/14_ScreenShot-Swagger_Post.png) 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. ![Image showing PUT action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/15_ScreenShot-Swagger_Put.png) 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. ![Image showing DELETE action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/16_ScreenShot-Swagger_Delete.png) > [!NOTE] > 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](https://document360.com/blog/api-documentation/) 2. [Destacado de funciones – API en Document360](https://www.google.com/search?q=Feature+spotlight+%E2%80%93+API+in+Document360&rlz=1C1CHBD_enIN1119IN1119&oq=Feature+spotlight+%E2%80%93+API+in+Document360&gs_lcrp=EgZjaHJvbWUyBggAEEUYOTIGCAEQRRg80gEHNDI5ajBqN6gCALACAA&sourceid=chrome&ie=UTF-8) --- ### Preguntas frecuentes #### ¿Qué debería hacer si actualizar la página termina mi sesión? Si actualizas la página, la sesión puede terminar y tendrás que autenticarte de nuevo. Sigue los pasos proporcionados para la autenticación. #### ¿Cómo debería formatear campos que requieran un carácter específico? Debes usar un guión bajo siempre que sea necesario. Por ejemplo, usa "email_id" en lugar de "email id". Usar espacios dará lugar a un error.