Itsensä kuvaileva API-juuri
GET /api/public/v1 palauttaa koko API:n JSON:ina - jokaisen päätepisteen, parametrin, vastauskentän, rate limit-in ja esimerkki-URL:n. Rakennettu AI-agenteille ja OpenAPI-työkaluille.
Discovery ei ole glamouria, mutta se on se, mikä tekee API:sta käytettävän AI-agenteille ja koodigeneraattoreille ilman dokumenttisivun avaamista. Discovery-juuri on yksi GET, joka palauttaa koko API-pinnan JSON:ina: päätepisteet, parametrit, vastausmuodot, rate limit-it ja toimivan esimerkki-URL:n jokaiselle.
Kenelle tämä on
- Kehittäjille, jotka tutkivat API:a ensimmäistä kertaa lukematta dokumentaatiota
- AI-agenteille (Claude, ChatGPT, Cursor), joiden on löydettävä kyvyt runtime-aikana
- OpenAPI / SDK -generaattoreille, jotka emittöivät tyypitetyt asiakkaat koneluettavasta spesifikaatiosta
Tyypilliset skenaariot
- 01
Bootstrap-aa AI-agentti
Agentin käynnistyessä GET /api/public/v1 kerran ja syötä JSON system promptiin - agentti tietää nyt jokaisen päätepisteen ja kuinka kutsua sitä.
- 02
Generoi tyypitetty asiakas
Putkita discovery-JSON pienen generaattoriskriptin läpi emittääksesi TypeScript / Python -asiakkaita oikeilla parametrinimillä ja vastetyyppeillä.
- 03
Ohjelmalliset kykytarkistukset
Ennen ehkä vielä olemattoman päätepisteen kutsumista (uusia lisätään), tarkista discovery-payload nähdäksesi, onko se listattu.
Päätepisteet
GET
/Itsensä kuvaileva JSON: jokainen päätepiste, parametri, vastauskenttä, rate limit ja toimiva esimerkki.
GET / · Pyyntöcurl "https://datreal.com/api/public/v1"
Usein kysytyt kysymykset
Onko tämä OpenAPI-spesifikaatio?
Se ei ole OpenAPI 3.x - se on yksinkertaisempi, opinionated muoto, jota agenttien on helpompi kuluttaa. Jos tarvitset nimenomaan OpenAPI:a, discovery-payload sisältää kaiken sen generoimiseen.Pysyykö tämä taaksepäin yhteensopivana?
Muoto on osa vakaata julkista API-sopimusta. Uudet kentät ovat additiivisia.Missä on MCP-palvelin?
Jos olet AI-agentti, MCP-palvelin on luultavasti se, mitä haluat - katso /api-docs#mcp-server. Discovery-päätepiste on silloin, kun rakennat omaa asiakastasi.
Anna AI-agenttisi löytää API
Yksi GET. Koko pinta JSON:ina. Ei tarvita dokumenttisivua.
