Mendeteksi masalah dalam API yang diimpor

Saat Anda mengimpor sebuah API (OpenAPI, Swagger, dan format lain yang didukung), Restorm menyimpan dokumentasi terstruktur API tersebut pada folder variabel-nya. Tepat setelah impor — dan setiap kali Anda membuka kembali file itu — Restorm secara diam-diam memproyeksikan dokumentasi tersebut menjadi sebuah desain dan menjalankan validasi yang sama seperti yang diterapkan perancang API, sepenuhnya di latar belakang. Proses ini tidak pernah menghambat impor dan tidak pernah mengganggu apa yang sedang Anda kerjakan.

Jika tidak menemukan apa pun, Anda tidak akan melihat apa pun. Jika menemukan masalah struktural, Restorm menunjukkannya kepada Anda di dua tempat.

Tanda “!” di bilah sisi

Folder variabel yang membawa API yang ditandai menampilkan sebuah “!” kecil di sebelah kanan barisnya. Ini adalah sinyal sekilas bahwa desain API ini memiliki sesuatu yang perlu diperiksa — dan tanda itu menghilang dengan sendirinya begitu API kembali bersih (setelah impor ulang atau pembaruan API yang memperbaikinya).

Tab “Masalah”

Buka folder variabel dan folder itu akan memperoleh tab Masalah. Tab ini hanya muncul ketika masalah terdeteksi — API yang bersih tidak pernah menampilkannya.

Masalah dikelompokkan menurut jenis, sehingga dua puluh rute duplikat terbaca sebagai satu baris dengan hitungan, alih-alih dua puluh entri terpisah. Di bawah setiap jenis, Restorm mencantumkan entitas persis yang bersangkutan — sebuah rute menampilkan verba HTTP dan jalur aslinya, dan diperluas ke dokumentasi rute tersebut sehingga Anda dapat melihat apa yang dideklarasikannya tanpa meninggalkan tab.

Pemeriksaan ini mencerminkan pemeriksaan perancang API, jadi jenis masalah yang mungkin Anda lihat meliputi:

• rute duplikat — dua rute yang menjawab metode dan jalur yang sama;
• respons yang hilang — sebuah rute yang tidak mendeklarasikan respons sama sekali;
• jalur yang direservasi — sebuah rute yang berada pada jalur yang direservasi Mock Server (/swagger.json, /graphql, …), yang tidak akan pernah menjawab;
• masalah batasan — sebuah pola yang tidak valid, atau nilai minimum yang melebihi nilai maksimumnya.

Daftar ini bersifat baca-saja: daftar ini memberi tahu Anda apa yang harus diperbaiki, dan Anda memperbaikinya di sumbernya (impor ulang spesifikasi yang telah dikoreksi, atau ubah API-nya). Daftar ini dihitung ulang pada peristiwa yang mengubah sebuah API — pembukaan file, sebuah impor, sebuah pembaruan API — bukan pada setiap ketukan tombol.