IdiomaENES

Asistente con IA para tu referencia de API

El parámetro, el ejemplo y la página en la que está

Quien programa sabe la forma de lo que quiere y no el nombre que le pusiste. El buscador necesita el nombre; un asistente toma la descripción y devuelve el endpoint, con la página de la que salió.

La situacion de partida

Tu referencia está generada, completa y ordenada por recurso. La pregunta es cómo se pagina, la respuesta es una frase en una página de convenciones compartidas, y quien programa la encuentra tras cinco pestañas o tras preguntar en vuestra comunidad.

Que darle de comer
  • La referencia de la API, rastreada o empujada desde CI
  • Descripciones de OpenAPI
  • Readme de los SDK y ejemplos de código
  • Changelogs y guías de migración

Que hace

Lee lo que ya generas

Las descripciones de OpenAPI, los readme de los SDK y el changelog son documentos como cualquier otro, empujados desde CI cada vez que publicas.

Responde con el endpoint

La respuesta nombra la ruta y el campo y cita la página, que es lo que verifica quien programa antes de escribir la llamada.

Una base por versión

Una pregunta sobre la v2 no se responde desde la v1, porque nunca estuvieron en la misma base de conocimiento.

Preguntas que nos hacen

¿Va a escribir código que no funciona?

Responde desde tu referencia y la cita. Donde la referencia no cubre algo, lo dice en vez de inventarse un parámetro.

¿Podemos empujar la documentación desde CI?

Sí. El endpoint de ingesta REST recibe un documento por página con tu propio identificador, así que una reconstrucción actualiza en vez de duplicar.

¿Podemos tener una versión solo interna?

Sí. Una base de conocimiento aparte y un widget aparte, restringido a los dominios que autorices.

Conectalo con