Lompat ke konten
Aback Tools Logo

Kompresor JSON OpenAPI / Swagger

Tempel spesifikasi JSON OpenAPI 3.x atau Swagger 2.0 untuk menghapus deskripsi, contoh, dan ekstensi x-: mengurangi ukuran spesifikasi untuk pipeline pembuatan SDK dan impor gateway API. Berjalan sepenuhnya di browser Anda, tanpa registrasi.

OpenAPI / Swagger JSON Compressor

Paste an OpenAPI 3.x or Swagger 2.0 JSON specification to remove descriptions, examples, and x- extensions - reduces spec size for SDK generation pipelines and API gateway imports. Runs entirely in your browser.

Compression Options

Mengapa menggunakan kompresor OpenAPI kami?

  • Kompresi spesifikasi OpenAPI instan: tempel spesifikasi JSON OpenAPI 3.x atau Swagger 2.0 apa pun dan kompres secara instan di browser Anda: menghapus deskripsi, contoh, dan ekstensi x- dalam milidetik.
  • Kompresor OpenAPI online yang aman: spesifikasi API Anda tidak pernah meninggalkan perangkat. Semua kompresi berjalan lokal di browser: aman untuk spesifikasi API internal atau milik sendiri yang berisi informasi endpoint sensitif.
  • Opsi kompresi yang terperinci: pilih persis apa yang akan dihapus (deskripsi, ringkasan, contoh, ekstensi x-, tanda deprecated, atau spasi JSON) dengan pratinjau langsung dari keluaran terkompresi.
  • 100% gratis selamanya: kompres spesifikasi OpenAPI sebanyak yang Anda butuhkan, sepenuhnya gratis. Tanpa akun, tanpa langganan, tanpa batas ukuran file, dan tanpa iklan.

Apa itu kompresi spesifikasi OpenAPI?

Kompresi spesifikasi OpenAPI adalah proses menghapus bidang khusus dokumentasi dari spesifikasi JSON OpenAPI untuk mengurangi ukurannya demi kasus penggunaan programatik seperti pembuatan SDK, impor gateway API, dan pipeline CI/CD. Spesifikasi OpenAPI yang besar dapat mencapai beberapa megabyte saat menyertakan deskripsi yang bertele-tele, contoh inline, dan bidang ekstensi vendor: tidak ada satu pun yang diperlukan untuk pembuatan kode. Kompresor OpenAPI gratis kami menghapus bidang-bidang ini di browser Anda dan menunjukkan persis apa yang dihapus.

Cara kerja kompresor OpenAPI kami

  1. Tempel spesifikasi Anda: salin spesifikasi JSON OpenAPI 3.x atau Swagger 2.0 Anda dan tempel ke panel input. Gunakan tombol contoh untuk memuat spesifikasi sampel.
  2. Pilih opsi kompresi: pilih bidang mana yang akan dihapus (deskripsi, ringkasan, contoh, ekstensi x-, tanda deprecated, atau spasi JSON). Keluarannya diperbarui secara instan.
  3. Salin atau unduh: salin spesifikasi terkompresi ke clipboard atau unduh sebagai file .json, lalu gunakan di generator SDK atau gateway API Anda.

Apa yang dihapus selama kompresi

  • Deskripsi: semua bidang "description" dari path, operasi, parameter, body permintaan, respons, dan skema: hanya dokumentasi, tidak digunakan generator.
  • Contoh: bidang "example" dan "examples" dari skema dan parameter: hanya digunakan untuk merender dokumentasi.
  • Ekstensi x-: semua bidang ekstensi vendor yang dimulai dengan x-: metadata internal yang ditambahkan alat manajemen API.
  • Spasi JSON: semua indentasi, baris baru, dan spasi antar token: menghasilkan keluaran JSON terminifikasi satu baris.

Apa yang dipertahankan

Semua bidang struktural yang diperlukan untuk pembuatan SDK dan impor gateway API dipertahankan sepenuhnya: path, metode HTTP, ID operasi, parameter (name, in, required, schema), body permintaan, kode status respons, skema respons, definisi komponen, skema keamanan, dan URL server. Spesifikasi terkompresi secara fungsional identik dengan aslinya untuk semua kasus penggunaan programatik.

Pertanyaan yang Sering Diajukan

Kompresor OpenAPI menghapus bidang yang bertele-tele seperti deskripsi, contoh, dan ekstensi x- dari spesifikasi JSON OpenAPI untuk mengurangi ukurannya demi pembuatan SDK, impor gateway API, dan pipeline CI/CD. Kompresor OpenAPI online gratis kami berjalan sepenuhnya di browser Anda: tanpa registrasi maupun unggah ke server.

Tidak. Generator SDK (OpenAPI Generator, Swagger Codegen, Kiota) hanya menggunakan bidang struktural: path, operasi, parameter, body permintaan, skema respons, dan definisi komponen. Deskripsi dan contoh adalah bidang khusus dokumentasi yang tidak memengaruhi kode yang dihasilkan.

Ya, privasi penuh dijamin. Semua kompresi berjalan di sisi klien di browser Anda. Spesifikasi OpenAPI Anda, yang mungkin berisi path endpoint internal, skema autentikasi, dan model data milik sendiri, tidak pernah meninggalkan perangkat Anda dan tidak pernah diunggah ke server mana pun.

Ya. Kompresor OpenAPI 100% gratis, tanpa registrasi, tanpa langganan, tanpa batas ukuran spesifikasi, dan tanpa iklan. Anda dapat mengompres spesifikasi sebanyak yang Anda butuhkan.

Di OpenAPI 3.x, "summary" adalah deskripsi singkat satu baris tentang sebuah operasi (ditampilkan di navigasi dokumentasi API), sedangkan "description" adalah penjelasan lebih panjang berformat markdown. Keduanya bidang khusus dokumentasi: menghapusnya tidak berpengaruh pada pembuatan SDK maupun perilaku gateway API.

Bidang ekstensi x- adalah metadata khusus vendor yang ditambahkan oleh alat manajemen API, gateway, atau tooling internal (misalnya x-rate-limit, x-internal-id, x-amazon-apigateway-integration). Aman dihapus untuk pembuatan SDK, tetapi mungkin diperlukan untuk impor gateway API tertentu. Periksa dokumentasi gateway Anda sebelum menghapusnya.

Ya. Kompresor berfungsi dengan spesifikasi JSON Swagger 2.0 (swagger: "2.0") maupun OpenAPI 3.0/3.1 (openapi: "3.x.x"). Bidang yang sama (deskripsi, contoh, ekstensi x-) ada di kedua format dan dihapus oleh logika yang sama.

Versi kompresor saat ini hanya mendukung input JSON. Untuk mengompres spesifikasi YAML, konversikan dulu ke JSON dengan konverter YAML ke JSON, lalu kompres di sini.