Dibuja mi repo

Buscar en el mapa

GET https://seerepo.com/api/v1/repos/:repo/search

Encuentra partes por nombre o frase en todos los módulos del mapa, y archivos por su ruta. Cada resultado dice en qué módulo está. Hasta 20.

Petición

Parámetro Dónde Descripción
repo path El id del repo, o owner/name con %2F.
q query Al menos 2 caracteres.
curl "https://seerepo.com/api/v1/repos/6ad79fd8e89233277ded17c9/search?q=stripe" \
  -H "Authorization: Bearer $SEEREPO_KEY"

Respuesta

Campo Tipo Descripción
data.query string Lo que se buscó, como lo leyó SeeRepo.
data.parts[].name string El nombre de la parte.
data.parts[].world string La ruta del módulo en el que está.
data.parts[].phrase string Qué hace, en una línea.
data.parts[].path string Solo si se abre: su ruta.
data.files[].path string Un archivo cuya ruta coincide.
data.more boolean true si había más de 20.

Ejemplo

{
  "status": "success",
  "data": {
    "query": "stripe",
    "parts": [
      {
        "name": "Stripe webhook",
        "type": "action",
        "world": "/checkout",
        "worldName": "Checkout",
        "phrase": "Turns the plan on once Stripe confirms.",
        "file": "app/api/stripe/route.ts"
      }
    ],
    "files": [],
    "more": false
  }
}

Autenticación

Una clave de API como Authorization: Bearer sr_…. Ver Autenticación.

Errores

Código code Cuándo
400 bad_query Menos de 2 caracteres.

Además de los de todos los endpoints (401, 404, 429), ver Errores.