OpenAPI και llms.txt
Μηχαναγνώσιμες περιγραφές του API.
Δύο αρχεία περιγράφουν το API σε μηχαναγνώσιμη μορφή: το openapi.json για γεννήτριες κώδικα και clients API, το llms.txt για πράκτορες AI.
openapi.json
Η προδιαγραφή σε μορφή OpenAPI 3.0 περιγράφει τα endpoints με τις κύριες παραμέτρους τους, τις απαντήσεις, τα σφάλματα και την αυθεντικοποίηση. Καλύπτει επίσης τα γεγονότα που παραδίδουν τα webhooks. Για κάθε λεπτομέρεια, καθοριστική είναι αυτή η τεκμηρίωση.
https://handelsregister.ai/openapi.json
Πώς να το χρησιμοποιήσεις:
- Με μια γεννήτρια όπως το OpenAPI Generator, δημιουργείς έναν client με τύπους για τη γλώσσα σου.
- Εισήγαγε το αρχείο στο Postman, στο Insomnia ή στο Bruno και έχεις αμέσως όλα τα αιτήματα στη διάθεσή σου.
- Τα frameworks πρακτόρων δημιουργούν από το αρχείο ορισμούς εργαλείων για ένα γλωσσικό μοντέλο.
Άνοιξε το URL στον browser σου, αποθήκευσε το αρχείο και εισήγαγέ το.
llms.txt
Το llms.txt συνοψίζει το API ως σύντομο κείμενο για γλωσσικά μοντέλα: endpoints, παράμετροι, features, τιμές και οι σημαντικότεροι κανόνες.
https://handelsregister.ai/llms.txt
Δώσε το URL στον πράκτορα AI σου πριν γράψει κώδικα για το API. Έτσι γνωρίζει τα πραγματικά ονόματα παραμέτρων και πεδίων απάντησης.