Perancang API

Perancang API memungkinkan Anda merancang sebuah API lengkap langsung di Restorm: Anda mendeskripsikan data dan rute Anda, Restorm mengurus sisanya — ia menyajikan desain Anda seperti server mock sungguhan, dan ia menghasilkan kode aplikasi Anda dari template.

Ini adalah alat ideal untuk memulai sebuah API sebelum back-end-nya ada: buatlah maket kontraknya, biarkan klien Anda mengujinya, dan simpan semuanya tetap terversi di dalam proyek Anda.

Satu desain, beberapa bagian

Sebuah desain dibuat seperti elemen lainnya: klik kanan pada sebuah folder ▸ Tambah ▸ Desain API. Ia terbuka di tab-nya sendiri dan mengelompokkan beberapa bagian, yang dapat diakses dari bilah sisi:

Bagian	Fungsinya
Model	Entitas Anda dan propertinya — lihat Model, enum, dan properti.
Enum	Kumpulan nilai tertutup, dapat dipakai ulang sebagai tipe properti.
Rute	Titik masuk API, dikelompokkan menurut sumber daya — lihat Rute & CRUD.
Server	Menyajikan desain sebagai mock, dalam HTTP, GraphQL, SOAP, OData, atau gRPC — lihat Menyajikan desain sebagai mock.
Klien	Permintaan siap pakai yang memanggil mock yang sedang berjalan — lihat Klien.
Dokumentasi & Catatan	Dokumentasi dan catatan bebas yang dilampirkan pada desain.
Kode	Menghasilkan kode dari template Anda — lihat Generasi kode.

Pengaturan desain (nama, nilai bawaan) terbuka dengan mengeklik langsung pada simpul desain di bilah sisi.

Alur khas

1. Deskripsikan data Anda — buat model dan enum Anda, tambahkan propertinya, tipenya, dan batasannya.
2. Definisikan rute Anda — secara manual, atau dengan sekali klik lewat Hasilkan CRUD dari sebuah model.
3. Sajikan mock — jalankan server dan arahkan aplikasi atau klien Anda ke sana. Desain yang sama diproyeksikan secara otomatis ke setiap protokol yang diaktifkan.
4. Hasilkan kode — pilih satu atau beberapa template (milik Anda atau yang disediakan Restorm) dan hasilkan proyek yang sesuai.

Setiap langkah dijelaskan secara rinci di halaman-halaman bagian ini.