ÍNDICE
Empezar gratis
Nuevo · Referencia desde OpenAPI 3.1

Documentación
que de verdad
se lee.

ÍNDICE convierte tu OpenAPI en una referencia de API navegable, mantiene tus SDKs al día y suma búsqueda instantánea y versionado. Tus usuarios encuentran la respuesta en segundos, no en pestañas.

Publicar mis docs→ Ver la referencia
●Desde tu OpenAPI ●Búsqueda instantánea ●Versionado por defecto
docs.acme.dev / referencia ⌘K
POST /v1/payments
Crear un pago

Inicia un cargo contra un cliente. Devuelve el objeto payment con su estado.

// crea un pago de 49,00 € curl https://api.acme.dev/v1/payments \ -H "Authorization: Bearer sk_•••" \ -d amount=4900 -d currency=eur▋
200 OK cURL Node Python

Equipos que documentan su API con ÍNDICE

NorthpayHelikaVortexaQuantaCobaltFormaAurora API
La plataforma

Todo lo que tus docs
necesitan, de fábrica

Búsqueda, versionado y una referencia generada desde tu esquema. Sin mantener un sitio estático a mano ni perseguir cambios de API.

Búsqueda instantánea

Indexa cada página, endpoint y bloque de código. Resultados con teclado (⌘K) y respuestas que abren el ancla exacto.

Versionado por defecto

Publica v1, v2 y betas en paralelo. Cada versión tiene su URL y su selector; los enlaces antiguos nunca se rompen.

Referencia desde OpenAPI

Sube tu spec y ÍNDICE genera la referencia completa: endpoints, esquemas, ejemplos y un playground para probar en vivo.

</>

Snippets en cada lenguaje

Cada endpoint muestra cURL, Node, Python y Go listos para copiar, sincronizados con tus SDKs en cada release.

Guías en Markdown

Escribe tutoriales en MDX con componentes, callouts y pestañas. Vive en tu repo y se publica en cada push.

Analítica de lectura

Descubre qué buscan y no encuentran tus usuarios. Páginas más vistas, callejones sin salida y huecos en la docs.

Una línea para publicar

De tu repo a docs
en un comando

Apunta ÍNDICE a tu OpenAPI y tu carpeta de guías. Cada push despliega una nueva versión, con preview por rama y rollback al instante.

npm i -g indice indice deploy CI · GitHub Actions
i
Tip — drift detection

Si tu API cambia y el spec no, ÍNDICE avisa en el PR. La referencia y el código nunca se desincronizan en silencio.

● indice.config.ts TypeScript 
// publica la referencia + las guías en cada push
import { defineDocs } from "indice"

export default defineDocs({
  name: "Acme API",
  openapi: "./openapi.yaml",   // → referencia
  guides:  "./guias/**/*.mdx",
  search:  true,                 // índice ⌘K
  versions: ["v2", "v1"],     // selector
})

// → docs.acme.dev · build 4.1s · 312 páginas
deploy ✓ preview por rama 312 páginas · 0 enlaces rotos
Referencia de API

Cada endpoint,
navegable y probable

Generada desde tu OpenAPI: métodos, parámetros, esquemas y ejemplos de respuesta. Con un playground para lanzar peticiones reales sin salir de la página.

GET /v1/payments/:id 200 · 404
POST /v1/payments 201 · 402
POST /v1/refunds 201
DELETE /v1/webhooks/:id 204
●Esquemas expandibles ●Ejemplos de respuesta ●Playground en vivo ●Webhooks documentados
4.1s
build medio de 300+ páginas
42ms
latencia de búsqueda p50
100/100
Lighthouse de fábrica
9 langs
snippets sincronizados

“Migramos años de docs en una tarde. Los tickets de “¿cómo se usa este endpoint?” cayeron a la mitad en un mes.”

Marta Iglesias
DevRel · Northpay
Empieza hoy

Publica unas docs
de las que presumir

Conecta tu OpenAPI, escribe tus guías en Markdown y despliega en minutos. Gratis para proyectos open source.

Crear mis docs gratis→ Ver una demo
Gratis para open source·sin tarjeta·dominio propio incluido