Semua istilah

OpenAPI

OpenAPI adalah skema terbaca mesin yang menjabarkan setiap endpoint, parameter, dan respons sebuah REST API, dan darinya klien bisa dihasilkan.

Rinciannya

API ini menerbitkan dokumen OpenAPI 3.1 berdampingan dengan indeks llms.txt, dan itulah yang membuat generator SDK, koleksi Postman, atau kerangka kerja agen bisa memahami permukaannya tanpa ada yang membaca prosa lebih dulu. Dokumen itu adalah sumber kebenaran untuk bentuk permintaan dan kode status. Perubahan perilaku diumumkan di changelog sebelum dirilis, jadi klien yang dihasilkan bisa dibuat ulang dengan sengaja alih-alih ketahuan rusak.

Dikenal juga sebagai

  • swagger
  • api schema

Istilah terkait