Memperbarui dari sumber

Sebuah spesifikasi API terus hidup. Mengimpor ulang dengan menimpa semuanya akan menghilangkan penyesuaian Anda; mengimpor ulang di sebelahnya akan menghasilkan duplikat. Restorm melakukan hal ketiga: ia menghitung deltanya.

Cara kerjanya

Setiap impor yang berhasil menyimpan sebuah sidik jari sumber pada folder variabel yang dibuatnya. Tombol Segarkan pada foldernya mengambil sumbernya, membandingkan sidik jarinya, lalu menerapkan perbedaannya alih-alih memulai dari nol:

• operasi baru ditambahkan, di tempat yang akan dipilih oleh impor baru;
• operasi yang berubah parameternya dilengkapi dengan apa yang ditambahkan spesifikasinya;
• operasi yang ditandai usang oleh spesifikasinya dilaporkan dan tampak meredup di dalam pohon;
• operasi yang hilang dari sumbernya dilaporkan sebagai dihapus dan tampak dicoret — operasi itu tetap dapat dieksekusi dan tidak pernah dihapus;
• perubahan Anda dipertahankan: nama, metode, URL, dan nilai yang Anda isi tidak pernah ditimpa.

Prinsipnya: spesifikasi berwenang atas apa yang digambarkannya, Anda berwenang atas selebihnya.

Uraian lengkapnya — di mana letak tombolnya, apa yang ditampilkan asistennya sebelum menerapkan, apa yang terjadi pada dokumentasinya — dijelaskan di Mengakses dan memperbarui dokumentasi sebuah API yang diimpor.

Hanya untuk impor lewat URL

Sinkronisasi ulang mengandaikan Restorm mengetahui sumbernya. Hanya impor yang dilakukan dari sebuah URL yang menyimpannya; impor dari file atau lewat penempelan tidak dapat disinkronkan ulang, sekalipun formatnya tercantum dalam daftar di bawah ini.

Format yang dapat disinkronkan ulang

Dua belas format tercakup:

• OpenAPI 3.x
• Swagger 2.0 (halaman yang sama dengan sebelumnya, tetapi dihitung terpisah di sini: keduanya memiliki logika sinkronisasi ulangnya masing-masing)
• GraphQL (SDL)
• gRPC — file .proto dan refleksi server
• SOAP / WSDL
• OData
• AsyncAPI
• Postman
• Insomnia
• Bruno
• OpenRPC
• Smithy

Format yang tidak dapat disinkronkan ulang

HAR, cURL, PowerShell, REST Client, Thunder Client, Paw, HTTPie, RAML, WADL, Thrift, TypeSpec, API Blueprint, tRPC.

Untuk format-format itu, sebuah impor baru akan membuat pohon baru: Andalah yang harus menyatukan keduanya, atau mengimpornya ke dalam folder tersendiri.

Kasus khusus: gRPC lewat refleksi

Permintaan gRPC yang diimpor lewat refleksi memiliki tombol Segarkan dari refleksi langsung pada tabnya: inilah jalan terpendek ketika sebuah layanan berubah di tengah pengembangan.