Mengimpor sebuah API
Restorm mengenali dua puluh empat format dan membangun kembali dari format-format itu sebuah pohon proyek yang lengkap: folder, permintaan, lingkungan, dokumentasi API, enumerasi.
Ini hampir selalu menjadi titik awal terbaik: jangan menulis permintaan Anda secara manual jika sebuah spesifikasi sudah ada.
Cara mengimpor
Section titled “Cara mengimpor”File ▸ Impor (Ctrl+I) menerima:
- sebuah file dari disk;
- sebuah URL — berguna untuk
swagger.jsonatau$metadatayang disajikan daring; - konten yang ditempelkan — begitulah sebuah perintah
curldiubah menjadi permintaan.
Restorm mendeteksi formatnya sendiri: pertama dari ekstensi filenya, lalu dengan menganalisis isinya. Anda tidak perlu memilih apa pun.
Formatnya
Section titled “Formatnya”Spesifikasi API
Section titled “Spesifikasi API”| Format | Halaman |
|---|---|
| OpenAPI 3.x dan Swagger 2.0 | OpenAPI / Swagger |
| Skema GraphQL (SDL) | GraphQL |
File .proto dan refleksi gRPC | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| Skema tRPC | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Koleksi dari klien lain
Section titled “Koleksi dari klien lain”| Format | Halaman |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Tangkapan dan baris perintah
Section titled “Tangkapan dan baris perintah”| Format | Halaman |
|---|---|
| HAR (tangkapan peramban) | HAR |
Perintah curl | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Apa yang Anda peroleh
Section titled “Apa yang Anda peroleh”Bergantung pada kekayaan format sumbernya:
- sebuah folder variabel dengan satu atau beberapa lingkungan, beserta URL dasar yang diambil dari spesifikasinya;
- sebuah struktur folder — menurut label, menurut layanan, atau menurut sumber daya, tergantung formatnya;
- sebuah permintaan per operasi, dengan tipe yang sesuai protokolnya;
- dokumentasi API yang terlampir pada foldernya: model, deskripsi, skema keamanan, contoh respons;
- enumerasi dari spesifikasinya, yang dapat dipakai ulang sebagai tipe nilai;
- header autentikasi yang sudah terpasang beserta variabelnya — lihat Autentikasi.
Setelah impor, setiap pasangan kunci / nilai yang nilainya diselesaikan menjadi kosong akan dinonaktifkan secara otomatis: pengiriman pertama Anda karenanya tidak berangkat dengan segerombolan header kosong.
Dokumentasi API yang diimpor
Section titled “Dokumentasi API yang diimpor”Sebuah impor tidak hanya menghasilkan permintaan: ia juga menyimpan dokumentasi API-nya — deskripsi, model, keamanan, contoh, enumerasi — yang dapat dilihat di tab Docs pada folder yang dibuat. Lihat Mengakses dan memperbarui dokumentasi sebuah API yang diimpor.
Memperbarui sebuah impor
Section titled “Memperbarui sebuah impor”Dua belas format dapat disinkronkan ulang: Restorm membandingkan versi baru sumbernya dengan pohon yang sudah ada lalu menerapkan deltanya, tanpa menghilangkan perubahan Anda. Lihat Memperbarui dari sumber.
Bagaimana dengan ekspor?
Section titled “Bagaimana dengan ekspor?”Restorm menghasilkan cuplikan kode untuk setiap permintaan, dalam semua bahasa yang relevan bagi protokolnya. Lihat Ekspor kode.