OpenAPI
OpenAPI è uno schema leggibile dalle macchine che descrive endpoint, parametri e risposte di un'API REST, e da cui si generano i client.
In dettaglio
Questa API pubblica un documento OpenAPI 3.1 accanto a un indice llms.txt, ed è quello che permette a un generatore di SDK, a una collection Postman o a un framework per agenti di capire la superficie senza che nessuno legga prima della prosa. È la fonte di verità per la forma delle richieste e per i codici di stato. I cambi di comportamento sono annunciati sul changelog prima di andare in produzione, così un client generato si rigenera di proposito invece di scoprirsi rotto.
Detto anche
- swagger
- api schema