Pašaprakstoša API sakne
GET /api/public/v1 atgriež visu API kā JSON - katru galapunktu, parametru, atbildes lauku, rate limit un piemēra URL. Veidots AI aģentiem un OpenAPI tooling-am.
Atklāšana nav glamorous, bet tā ir tas, kas padara API izmantojamu AI aģentiem un kodu ģeneratoriem bez dokumentācijas atvēršanas. Atklāšanas sakne ir viens GET, kas atgriež visu API virsmu kā JSON: galapunkti, parametri, atbilžu formas, rate limit-i un strādājošs piemērs katram.
Kam tas paredzēts
- Izstrādātājiem, kas pirmo reizi pēta API bez dokumentācijas lasīšanas
- AI aģentiem (Claude, ChatGPT, Cursor), kuriem jāatklāj iespējas runtime-ā
- OpenAPI / SDK ģeneratoriem, kas izveido tipētos klientus no mašīnlasāmas specifikācijas
Tipiski lietošanas scenāriji
- 01
Bootstrap AI aģentam
Aģenta start-up brīdī GET /api/public/v1 vienreiz un ievieto JSON system prompt-ā - aģents tagad zina katru galapunktu un kā to izsaukt.
- 02
Ģenerē tipēto klientu
Padod atklāšanas JSON cauri nelielam ģeneratora skriptam, lai izveidotu TypeScript / Python klientus ar pareiziem parametru nosaukumiem un atbilžu tipiem.
- 03
Programmatiskas spēju pārbaudes
Pirms izsaukt galapunktu, kas vēl varbūt neeksistē (jauni tiek pievienoti), pārbaudi atklāšanas payload, vai tas ir uzskaitīts.
Galapunkti
GET
/Pašaprakstošs JSON: katrs galapunkts, parametrs, atbildes lauks, rate limit un piemērs.
GET / · Pieprasījumscurl "https://datreal.com/api/public/v1"
Bieži uzdotie jautājumi
Vai tā ir OpenAPI specifikācija?
Tā nav OpenAPI 3.x - tā ir vienkāršāka, opinionated forma, ko aģentiem ir vieglāk patērēt. Ja konkrēti vajag OpenAPI, atklāšanas payload satur visu vajadzīgo, lai to ģenerētu.Vai tas paliks atpakaļsavietojams?
Forma ir stabila publiskā API līguma daļa. Jaunie lauki ir aditīvi.Kur ir MCP serveris?
Ja tu esi AI aģents, MCP serveris droši vien ir tas, ko tu gribi - skat. /api-docs#mcp-server. Atklāšanas galapunkts ir tad, kad tu būvē savu klientu.
Ļauj savam AI aģentam atklāt API
Viens GET. Visa virsma kā JSON. Bez dokumentācijas lapas.
