OpenAPI ja llms.txt
API:n koneluettavat kuvaukset.
Kaksi tiedostoa kuvaa API:n koneluettavassa muodossa: openapi.json koodigeneraattoreille ja API-asiakasohjelmille, llms.txt AI-agenteille.
openapi.json
OpenAPI 3.0 -muotoinen määrittely kuvaa päätepisteet tärkeimpine parametreineen, vastauksineen, virheineen ja tunnistautumisineen. Se kattaa myös webhookien toimittamat tapahtumat. Kaikissa yksityiskohdissa tämä dokumentaatio on ratkaiseva.
URL
https://handelsregister.ai/openapi.json
Näin käytät sitä:
- Generaattorilla, kuten OpenAPI Generatorilla, luot tyypitetyn asiakasohjelman omalle kielellesi.
- Tuo tiedosto Postmaniin, Insomniaan tai Brunoon, niin kaikki pyynnöt ovat heti käsillä.
- Agenttikehykset rakentavat tiedostosta kielimallille työkalumäärittelyt.
Avaa URL selaimessa, tallenna tiedosto ja tuo se.
Version 1 sisällä tulee uusia kenttiä ja arvoja, ja olemassa olevat säilyvät. Rakenna asiakasohjelmasi niin, että se ohittaa tuntemattomat kentät. Lisää muutoslokissa.
llms.txt
llms.txt tiivistää API:n lyhyeksi tekstiksi kielimalleille: päätepisteet, parametrit, ominaisuudet, hinnat ja tärkeimmät säännöt.
URL
https://handelsregister.ai/llms.txt
Anna URL AI-agentillesi ennen kuin se kirjoittaa koodia API:a varten. Näin se tuntee todelliset parametrien nimet ja vastauskentät.