---
title: "Navegando Swagger UI"
description: "Aprende a usar la interfaz de Swagger para explorar y probar la API de API Gateway"
type: "academy"
category: "lesson"
tags: []
authors: [Anonymous]
date: "2026-08-27"
last_update: "2026-08-21"
time_minutes: 2
draft: false
unlisted: false
url: "https://www.stage.apigateway.cl/academy/capacitacion-inicial/primeros-pasos/navegando-swagger"
---

# Navegando Swagger UI

Swagger UI es una herramienta interactiva que te permite explorar, entender y probar la API directamente desde tu navegador. No necesitas escribir código ni usar herramientas externas - todo está integrado en una interfaz visual amigable.

---

## Accediendo a Swagger UI

### URL de Acceso

Para acceder a la documentación interactiva de API Gateway:

```
https://www.apigateway.cl/docs
```

### Primera Vista

Al ingresar, verás:
- **Título de la API**: "API Gateway"
- **Descripción general**: Información sobre los servicios disponibles
- **Versión**: Version actual de la API (1.0.0)
- **Servidor base**: URL donde se ejecutan las peticiones

---

## Estructura de la Interfaz

### Secciones de Endpoints [CORREGIR]

Los endpoints están organizados por categorías:

```
📁 SII - Consultas
  └── GET /sii/contribuyentes/{rut}
  └── POST /sii/situacion-tributaria
  └── POST /sii/actividades

📁 LibreDTE - Emisión
  └── POST /libredte/dte/documentos/generar
  └── POST /libredte/dte/envios/enviar

📁 Utilidades
  └── GET /utilidades/validar-rut
  └── POST /utilidades/convertir-moneda
```

### Colores y Métodos HTTP

Cada método HTTP tiene un color específico:

| Método | Color | Uso típico |
|--------|-------|------------|
| **GET** | 🟦 Azul | Consultar información |
| **POST** | 🟩 Verde | Enviar datos/Crear recursos |
| **PUT** | 🟨 Amarillo | Actualizar completo |
| **DELETE** | 🟥 Rojo | Eliminar recursos |

---

## Funcionalidad "Try it out"

### Activar el Modo de Prueba

> [!WARNING] Importante
>
> **Ojo que estarás probando directamente en el SII, no en la API Gateway.**

1. Selecciona cualquier endpoint
2. Haz clic en el botón **"Try it out"** (esquina superior derecha)
3. Los campos se vuelven editables

### Completar los Datos

Según el tipo de endpoint:

#### Para GET con parámetros:
```
Path parameter:
rut: [76192083-9] <- Editable

Query parameters:
formato: [json ▼] <- Dropdown con opciones
```

#### Para POST con body:
```json
{
  "auth": {
    "pass": {
      "rut": "11111111-1",
      "clave": "miclave"
    }
  }
}
```

### Configurar Autorización

Antes de ejecutar endpoints protegidos:

1. Busca el botón **"Authorize"** 🔐 (parte superior)
2. Ingresa tu Bearer Token:
   ```
   Bearer tu_access_token_aqui
   ```
3. Clic en **"Authorize"**
4. El candado se cierra indicando autorización activa

---

## Ejecutar y Ver Resultados

### Botón Execute

Una vez configurados los parámetros:
1. Clic en **"Execute"**
2. Swagger envía la petición real a la API
3. Aparece la sección de respuesta

### Interpretando la Respuesta

La respuesta muestra:

1. **Curl Command**
   ```bash
   curl -X POST "https://legacy.apigateway.cl/api/v1/sii/..." \
     -H "accept: application/json" \
     -H "Authorization: Bearer ..." \
     -d "{...}"
   ```

2. **Request URL**
   ```
   https://legacy.apigateway.cl/api/v1/sii/situacion-tributaria
   ```

3. **Response Status**
   ```
   Code: 200 OK
   ```

4. **Response Headers**
   ```
   content-type: application/json
   x-ratelimit-limit: 1000
   x-ratelimit-remaining: 999
   ```

5. **Response Body**
   ```json
   {
     "rut": "76192083-9",
     "razon_social": "EMPRESA DEMO",
     "estado": "ACTIVO"
   }
   ```


---
Last updated on 21/08/2026