Save aprašanti API šaknis
GET /api/public/v1 grąžina visą API kaip JSON - kiekvieną tašką, parametrą, atsakymo lauką, rate limit ir pavyzdžio URL. Sukurta AI agentams ir OpenAPI tooling-ui.
Atradimas nėra glamour, bet tai, kas padaro API naudojamą AI agentams ir kodo generavimo įrankiams be dokumentacijos atvėrimo. Atradimo šaknis yra vienas GET, grąžinantis visą API paviršių kaip JSON: taškai, parametrai, atsakymų formos, rate limit-ai ir veikiantis pavyzdžio URL kiekvienam.
Kam tai skirta
- Kūrėjams, pirmą kartą tyrinėjantiems API neskaitant dokumentacijos
- AI agentams (Claude, ChatGPT, Cursor), kuriems reikia atrasti galimybes runtime-e
- OpenAPI / SDK generatoriams, kurie sukuria tipuotus klientus iš mašininiu būdu nuskaitomos specifikacijos
Įprasti scenarijai
- 01
Bootstrap-ink AI agentą
Agento start-up metu GET /api/public/v1 vieną kartą ir įdėk JSON į system prompt - agentas dabar žino kiekvieną tašką ir kaip jį iškviesti.
- 02
Generuok tipuotą klientą
Perduok atradimo JSON per nedidelį generatoriaus skriptą, kad sukurtum TypeScript / Python klientus su tinkamais param vardais ir atsakymo tipais.
- 03
Programinis galimybių patikrinimas
Prieš iškviečiant tašką, kuris dar gali neegzistuoti (nauji pridedami), patikrink atradimo payload, ar jis yra sąraše.
Galutiniai taškai
GET
/Save aprašantis JSON: kiekvienas taškas, parametras, atsakymo laukas, rate limit ir veikiantis pavyzdys.
GET / · Užklausacurl "https://datreal.com/api/public/v1"
Dažniausiai užduodami klausimai
Ar tai OpenAPI specifikacija?
Tai ne OpenAPI 3.x - tai paprastesnė, opinionated forma, kurią agentams lengviau vartoti. Jei konkrečiai reikia OpenAPI, atradimo payload turi viską, ko reikia, kad jį sugeneruotum.Ar tai išliks atgaline išmokoje?
Forma yra stabilios viešo API sutarties dalis. Nauji laukai yra papildomi.Kur yra MCP serveris?
Jei tu esi AI agentas, MCP serveris greičiausiai yra tai, ko nori - žiūrėk /api-docs#mcp-server. Atradimo taškas yra tada, kai kuri savo paties klientą.
Leisk savo AI agentui atrasti API
Vienas GET. Visas paviršius kaip JSON. Be dokumentacijos puslapio.
