OpenAPI és llms.txt
Az API géppel olvasható leírásai.
Két fájl írja le az API-t géppel olvasható formában: az openapi.json kódgenerátoroknak és API-klienseknek, az llms.txt AI-ügynököknek.
openapi.json
Az OpenAPI 3.0 formátumú specifikáció leírja a végpontokat a fő paramétereikkel, válaszaikkal, hibáikkal és a hitelesítéssel. A webhookok által szállított eseményeket is lefedi. Minden részletben ez a dokumentáció a mérvadó.
URL
https://handelsregister.ai/openapi.json
Így használod:
- Egy generátorral, például az OpenAPI Generatorral típusos klienst készítesz a nyelvedhez.
- Importáld a fájlt a Postmanbe, az Insomniába vagy a Brunóba, és azonnal kéznél van az összes kérés.
- Az ügynök-keretrendszerek a fájlból eszközdefiníciókat építenek egy nyelvi modell számára.
Nyisd meg az URL-t a böngészőben, mentsd el a fájlt, és importáld.
Az 1-es verzión belül új mezők és értékek jönnek, a meglévők maradnak. Úgy építsd a kliensedet, hogy figyelmen kívül hagyja az ismeretlen mezőket. Bővebben a changelogban.
llms.txt
Az llms.txt rövid szövegként foglalja össze az API-t nyelvi modelleknek: végpontok, paraméterek, funkciók, árak és a legfontosabb szabályok.
URL
https://handelsregister.ai/llms.txt
Add meg az URL-t az AI-ügynöködnek, mielőtt kódot ír az API-hoz. Így ismeri a valódi paraméterneveket és válaszmezőket.