Iseennast kirjeldav API juur
GET /api/public/v1 tagastab kogu API JSON-ina - iga otspunkti, parameetri, vastusvälja, rate limit-i ja näite URL-i. Loodud AI agentidele ja OpenAPI tööriistadele.
Avastamine pole glamour, aga see on see, mis teeb API kasutatavaks AI agentidele ja koodigeneraatoritele ilma dokumendilehte avamata. Avastamise juur on üks GET, mis tagastab kogu API pinda JSON-ina: otspunktid, parameetrid, vastuste vormid, rate limit-id ja töötav näite URL igale.
Kellele see on
- Arendajatele, kes uurivad API-d esimest korda ilma dokumentatsiooni lugemata
- AI agentidele (Claude, ChatGPT, Cursor), kes peavad runtime-il võimekusi avastama
- OpenAPI / SDK generaatoritele, mis emiteerivad tüübitud kliente masinloetava spetsifikatsiooni järgi
Tüüpilised stsenaariumid
- 01
Bootstrap-i AI agent
Agendi käivitamisel GET /api/public/v1 üks kord ja sisesta JSON system prompti - agent teab nüüd iga otspunkti ja seda, kuidas seda kutsuda.
- 02
Genereeri tüübitud klient
Edasta avastamise JSON läbi väikese generaatoriskripti, et emiteerida TypeScript / Python kliente õigete param nimede ja vastusetüüpidega.
- 03
Programmeeritav võimekuste kontroll
Enne otspunkti kutsumist, mida ehk veel ei eksisteeri (uusi lisatakse), kontrolli avastamise payload-i, kas see on loetletud.
Otspunktid
GET
/Iseennast kirjeldav JSON: iga otspunkt, parameeter, vastusväli, rate limit ja töötav näide.
GET / · Päringcurl "https://datreal.com/api/public/v1"
Korduma kippuvad küsimused
Kas see on OpenAPI spetsifikatsioon?
See pole OpenAPI 3.x - see on lihtsam, opinionated vorm, mida agentidel on lihtsam tarbida. Kui sul on konkreetselt OpenAPI vaja, sisaldab avastamise payload kõike, mida vajad selle genereerimiseks.Kas see jääb tagasiühilduvaks?
Vorm on stabiilse avaliku API lepingu osa. Uued väljad on additiivsed.Kus on MCP server?
Kui sa oled AI agent, on MCP server tõenäoliselt see, mida sa tahad - vaata /api-docs#mcp-server. Avastamise otspunkt on siis, kui ehitad oma klienti.
Lase oma AI agendil API avastada
Üks GET. Kogu pind JSON-ina. Pole vaja dokumendilehte.
