Gambaran Umum

Schema, sebuah konsep fundamental dalam OpenAPI Specification (OAS), juga umum disebut sebagai Data Model. Sebuah schema mendefinisikan tipe data dan properti yang diharapkan dari objek permintaan dan respons API.

JSON Schema berfungsi sebagai standar yang diadopsi oleh Apidog untuk memodelkan struktur data yang digunakan oleh API Anda.

Dengan schema, Anda dapat:

Mendefinisikan struktur data standar (seperti objek Order).

Mengintegrasikan schema dengan contoh yang dihasilkan secara otomatis.

Memanfaatkan struktur data secara berulang di seluruh proyek API Anda.

Tujuan Schema di Apidog

Di dalam Apidog, schema memainkan peran penting dalam:

Tujuan	Deskripsi
Merancang API	Dengan mendefinisikan schema sejak awal pada fase desain, developer dapat memvisualisasikan dan menyempurnakan struktur data yang akan ditangani oleh API mereka.
Layanan Mock	Apidog menggunakan schema yang telah didefinisikan untuk menghasilkan respons mock, sehingga developer dapat menyimulasikan perilaku API dan interaksi front-end bahkan sebelum implementasi aktual dilakukan.
Dokumentasi	Dokumentasi API yang akurat dan komprehensif dihasilkan secara otomatis berdasarkan schema, sehingga memfasilitasi komunikasi yang jelas dengan konsumen API mengenai format dan struktur data yang diharapkan.
Debugging	Schema digunakan untuk memvalidasi respons dalam debugging API, memastikan bahwa respons API mematuhi model data yang telah didefinisikan.

Membuat Schema

Pertimbangkan cakupan schema Anda: Apakah data akan digunakan di beberapa bagian API atau beberapa API, atau apakah data tersebut spesifik untuk satu kasus penggunaan?

Jika struktur data dimaksudkan untuk beberapa penggunaan, membuat schema akan memfasilitasi manajemen terpusat dan konsistensi.

Anda dapat menambahkan schema di bawah direktori "Schemas".

Membangun Schema

Manfaatkan Schema Editor yang mudah digunakan di Apidog untuk secara efektif membangun schema yang selaras dengan spesifikasi JSON Schema.

Anda juga dapat membangun schema dengan mengimpor dari tabel database atau data JSON/JSON schema.

Menerapkan Schema

Setelah membuat schema yang dapat digunakan kembali, buka endpoint untuk mereferensikan schema dalam body permintaan atau respons, atau dalam schema lain. Dengan mereferensikan model data bersama, Anda dapat menjaga konsistensi dan menyederhanakan integrasi model data di berbagai komponen desain API Anda.

Tujuan Schema di Apidog#

Membuat Schema#

Membangun Schema#

Menerapkan Schema#

Tujuan Schema di Apidog

Membuat Schema

Membangun Schema

Menerapkan Schema