Kedua alat ini beroperasi di terminal Anda, keduanya berbicara OpenAPI, dan keduanya muncul ketika sebuah tim memutuskan menginginkan alur kerja baris perintah untuk spesifikasi API-nya. Di situlah tumpang tindih berakhir. Mereka menyelesaikan masalah yang berdekatan dari arah yang berlawanan, dan memilih yang salah berarti melawan linter yang tidak menjalankan pengujian atau menggunakan platform padahal yang Anda inginkan hanyalah pemeriksaan struktural yang cepat.
Ini adalah perbandingan langsung tingkat perintah antara CLI Apidog dan Redocly CLI. Tanpa argumen lemah. Redocly CLI adalah perangkat lunak sumber terbuka yang benar-benar bagus, dan Anda akan melihat dengan tepat di mana keunggulannya sebelum keputusan apa pun dibuat.
Putusan TL;DR
Mereka menyelesaikan masalah yang tumpang tindih tetapi berbeda.
Redocly CLI (@redocly/cli, biner redocly) adalah spesialis OpenAPI yang mengutamakan kode: melakukan lint dengan aturan khusus, menggabungkan spesifikasi multi-file, memisahkan dan menggabungkannya, serta membangun dokumen HTML mandiri. Ini adalah sumber terbuka, digerakkan oleh konfigurasi, dan berbasis terminal. Jika spesifikasi Anda adalah sumber kebenaran dan disimpan di git, ini adalah tata kelola yang Anda jalankan dari baris perintah.
Apidog CLI (apidog-cli, biner apidog) adalah antarmuka baris perintah dari platform API all-in-one. Ini mengimpor dan mengekspor definisi terhadap suatu proyek dan menjalankan skenario pengujian API di CI dengan laporan JUnit dan HTML. Ia mendapatkan tempatnya ketika spesifikasi yang sama juga perlu di-mock, diuji, dan didokumentasikan dalam satu ruang kerja alih-alih disatukan dari alat terpisah.
Pilih Redocly CLI ketika Anda menginginkan linter, bundler, dan pembuat dokumen sumber terbuka yang ringan yang Anda jalankan sepenuhnya dari terminal. Pilih Apidog ketika Anda lebih suka memiliki satu alat untuk seluruh siklus hidup API. Keduanya juga dapat bekerja berdampingan, dan bagian terakhir menjelaskan caranya.
Dua filosofi yang berbeda
Redocly CLI berpusat pada file dan mengutamakan kode. Dokumen OpenAPI di disk adalah hal yang Anda tindak lanjuti. Setiap perintah, redocly lint, redocly bundle, redocly build-docs, mengambil jalur ke file dan melakukan tugasnya secara lokal, tanpa akun dan tanpa server yang terlibat. Perilaku dibentuk oleh konfigurasi redocly.yaml yang Anda masukkan ke repositori di samping spesifikasi. Model itu cocok untuk tim yang memperlakukan deskripsi API mereka sebagai kode sumber: ditinjau dalam permintaan tarik, di-gated di CI, di-versi seperti hal lainnya. Spesifikasi OpenAPI adalah kontraknya, dan Redocly CLI adalah rantai alat yang mengawasinya.
Apidog berpusat pada proyek dan mengutamakan platform. Anda mendesain titik akhir, membangun server tiruan, dan menulis skenario pengujian secara visual di aplikasi desktop atau web, dan CLI adalah antarmuka tanpa kepala untuk sebagian dari pekerjaan itu. Sebagian besar perintah CLI beroperasi terhadap proyek Apidog di server, diidentifikasi oleh ID proyek dan diautentikasi dengan token akses. Spesifikasi bukanlah file lepas yang Anda lint di tempat; itu diimpor ke ruang kerja hidup di mana ia juga dapat di-mock, diuji, dan diterbitkan sebagai dokumen. Satu lingkungan, banyak pekerjaan.
Tidak ada filosofi yang salah. Keduanya cocok untuk tim yang berbeda. Perbedaan jujurnya adalah ini: Redocly memberi Anda CLI sumber terbuka yang terfokus untuk tata kelola spesifikasi, dan Apidog memberi Anda CLI ke platform yang lebih luas.
Perintah demi perintah
Inilah bagian yang penting, dipetakan tugas demi tugas. Setiap perintah di bawah ini nyata; tidak ada yang dibuat-buat.
| Tugas | Redocly CLI | Apidog CLI |
|---|---|---|
| Validasi / lint | redocly lint dengan aturan bawaan dan kustom melalui redocly.yaml |
Memvalidasi struktur hanya saat impor; tidak ada perintah lint mandiri, tidak ada aturan kustom |
| Bundel spesifikasi multi-file | redocly bundle openapi.yaml |
apidog export ... --format openapi (menggabungkan menjadi satu file) |
| Memisahkan satu file menjadi banyak | redocly split |
Tidak tersedia |
| Menggabungkan beberapa file | redocly join (eksperimental) |
Tidak tersedia |
| Membangun dokumen HTML statis | redocly build-docs openapi.yaml -o docs.html |
apidog export ... --format html |
| Menjalankan pengujian API di CI | Tidak tersedia | apidog run ... -r "cli,html,json,junit" |
| Server tiruan | Tidak tersedia | Terintegrasi dalam aplikasi (bukan perintah CLI) |
| Aturan lint kustom | Ya, aturan gaya Spectral di redocly.yaml |
Tidak |
| Laporan pengujian CI (JUnit/HTML) | Tidak tersedia | Ya, melalui -r/--reporters |
| Sumber terbuka | Ya | Tidak (freemium) |
Beberapa baris ini memerlukan catatan yang lugas, karena perbedaannya nyata dan artikel ini akan tidak jujur tanpanya.
Linting adalah wilayah Redocly, bukan Apidog. Redocly CLI melakukan lint OpenAPI, AsyncAPI, Arazzo, dan Open-RPC terhadap aturan yang dapat dikonfigurasi, dan Anda dapat membuat aturan sendiri. Apidog memvalidasi struktur definisi saat Anda mengimpornya, tetapi tidak ada apidog lint, tidak ada konfigurasi gaya redocly.yaml, dan tidak ada cara untuk menulis aturan panduan gaya kustom melalui CLI. Jika tujuan Anda adalah panduan gaya yang mengutamakan kode yang diterapkan di terminal, Redocly adalah alatnya. Apidog tidak bersaing di sini, dan mengatakan sebaliknya akan salah.
Split dan join adalah milik Redocly. redocly split memecah satu deskripsi menjadi struktur multi-file, dan redocly join (eksperimental) menggabungkan beberapa file menjadi satu. Apidog tidak memiliki kedua perintah tersebut. Impornya menyelesaikan $ref multi-file menjadi sumber daya terpadu, dan ekspornya mengeluarkan satu file gabungan, tetapi itu tidak sama dengan utilitas split/join mandiri yang Anda jalankan pada file lepas.
Menjalankan pengujian dan mocking adalah milik Apidog. Redocly CLI tidak menjalankan pengujian API dan tidak menghosting server tiruan; itu di luar cakupannya secara desain. Apidog menjalankan skenario pengujian tanpa kepala dengan apidog run dan menghasilkan laporan JUnit, HTML, JSON, dan CLI untuk pipeline Anda, dan mocking adalah fitur kelas satu dari platform (dibuat di aplikasi, tidak digerakkan dari CLI).
Keduanya membangun dokumen HTML dari terminal. redocly build-docs menghasilkan file HTML Redoc mandiri. apidog export --format html menulis file dokumen HTML dari proyek Anda. Mesin berbeda, hasil terminal yang sama.
Perintah Redocly CLI yang sebenarnya
Instal secara global, atau lewati instalasi dan jalankan melalui npx:
npm install -g @redocly/cli@latest
# or, no global install:
npx @redocly/cli@latest lint openapi.yaml
Lakukan lint pada spesifikasi. Dengan adanya redocly.yaml, ini menerapkan aturan yang Anda pilih (minimal, recommended, recommended-strict, spec, atau aturan kustom):
redocly lint openapi.yaml
Jika Anda hanya menginginkan validasi struktural sederhana, seperti yang dulu dilakukan oleh swagger-cli yang sudah tidak digunakan, konfigurasikan redocly.yaml hanya dengan aturan spec dan jalankan redocly lint yang sama. Redocly menerbitkan panduan migrasi dari swagger-cli karena Redocly CLI adalah penerusnya yang ditunjuk. Repositori swagger-cli sekarang membawa pemberitahuan penghentian untuk alasan yang sama; alat lama itu hanya memvalidasi dan menggabungkan, tidak pernah melakukan lint dengan aturan gaya.
Gabungkan definisi multi-file menjadi satu file, mengikuti setiap $ref:
redocly bundle openapi.yaml --output bundled.json
Jika Anda beralih dari swagger-cli, flag-nya dapat dipetakan dengan rapi: -o/--outfile menjadi --output, -t/--type menjadi --ext (json, yaml, atau yml), dan -r/--dereference menjadi -d/--dereferenced.
Bangun dokumentasi HTML mandiri dengan Redoc:
redocly build-docs openapi.yaml -o docs.html
Pisahkan satu deskripsi menjadi tata letak multi-file, kebalikan dari bundling:
redocly split openapi.yaml --outDir ./split-spec
Untuk gambaran yang lebih luas tentang bagaimana Redocly bersaing dengan alat lain dalam kategori ini, panduan pengaturan linter OpenAPI mencakup Spectral, Redocly, dan Vacuum secara berdampingan, dan rangkuman alternatif Redocly secara khusus mencakup platform dokumen.
Perintah Apidog CLI yang sebenarnya
Instal CLI dan otentikasi dengan token dari aplikasi (avatar, lalu Pengaturan Akun, lalu Token Akses API):
npm install -g apidog-cli@latest
apidog login --with-token <TOKEN>
Token disimpan di ~/.apidog/config.toml. Jangan mencetaknya atau melakukan commit.
Impor definisi ke dalam proyek. Ini memvalidasi struktur dan memasukkannya, menyelesaikan $ref multi-file menjadi sumber daya terpadu:
apidog import --project 123456 --format openapi --file ./openapi.json
Impor menerima lebih dari sekadar OpenAPI: Postman, HAR, Insomnia, JMeter, WSDL, YApi, RAP2, apiDoc, Hoppscotch, Markdown, JSON Schema, dan format milik Apidog sendiri.
Ekspor satu file gabungan, secara opsional meningkatkan versi OpenAPI. Ini adalah gabungan ditambah peningkatan versi opsional dalam satu langkah:
apidog export --project 123456 --format openapi --output ./openapi.json --oas-version 3.1
Ekspor dokumen HTML langsung dari proyek:
apidog export --project 123456 --format html --output ./docs.html
Jalankan skenario pengujian di CI dan hasilkan laporan yang dapat dibaca oleh pipeline Anda:
apidog run --project 123456 -t <testScenarioId> -e <environmentId> -r "cli,html,json,junit"
Anda juga dapat menjalankan sepenuhnya secara offline dari file koleksi yang diekspor, tanpa perlu proyek atau token:
apidog run ./collection.apidog-cli.json
Referensi flag lengkap, termasuk --out-dir, -n/--iteration-count, -d/--iteration-data, dan --env-var, tersedia di panduan lengkap Apidog CLI. Dokumentasi resmi Apidog CLI mencakup instalasi dan setiap perintah sumber daya. Untuk perbandingan CI antar runner, lihat Apidog CLI vs Newman dan Bruno CLI vs Apidog CLI.
Kapan memilih Redocly CLI
Gunakan Redocly CLI ketika spesifikasi adalah sumber kebenaran Anda dan Anda ingin mengaturnya sebagai kode.
Anda menginginkan linter sejati dengan aturan kustom. Perintah lint Redocly dan konfigurasi redocly.yaml-nya adalah fitur unggulan: pilih set aturan bawaan atau tulis sendiri, dan terapkan konvensi penamaan, bidang wajib, serta gaya internal pada setiap commit. Tidak ada di CLI Apidog yang menyamai ini. Jika tata kelola gaya berbasis terminal adalah tugasnya, Redocly adalah jawabannya.
Anda menginginkan sumber terbuka tanpa akun. CLI berjalan sepenuhnya di mesin Anda atau runner CI. Tanpa login, tanpa token, tanpa panggilan server untuk lint, bundle, split, atau build-docs. Untuk lingkungan terisolasi atau aturan penanganan data yang ketat, itu adalah persyaratan keras yang dipenuhi Redocly dan umumnya tidak dipenuhi oleh CLI platform.
Anda menginginkan toolchain yang ringan dan terfokus. Jika yang Anda butuhkan hanyalah lint, bundel, pisah, gabung, dan dokumen HTML dari terminal, Redocly melakukan persis itu dan tidak lebih. Anda dapat menginstalnya atau menjalankannya melalui npx tanpa pengaturan apa pun. Set perintah lengkap ada di dokumen Redocly CLI dan halaman paket npm.
Kapan memilih Apidog
Gunakan Apidog ketika spesifikasi adalah satu bagian dari siklus hidup yang lebih besar yang Anda tidak ingin menyusunnya dari alat terpisah.
Anda menginginkan desain, mock, pengujian, dan dokumen di satu tempat. CLI mengimpor spesifikasi Anda, mengekspor file gabungan yang bersih pada versi OpenAPI yang Anda pilih, dan menjalankan skenario pengujian di CI. Proyek yang sama juga memberi Anda desain visual, server tiruan, dan dokumentasi yang dipublikasikan, semuanya berbagi satu definisi. Anda berhenti menyatukan linter, alat mock, test runner, dan generator dokumen.
Anda menginginkan eksekusi pengujian di pipeline Anda dengan laporan yang dapat digunakan. apidog run menghasilkan JUnit XML untuk dashboard CI Anda, ditambah artefak HTML dan JSON, dan keluar dengan kode non-nol jika pengujian gagal. Redocly sama sekali tidak menjalankan pengujian, jadi jika gerbang pengujian CI ada dalam daftar Anda, di sinilah Apidog cocok. Pola dalam validasi OpenAPI di CI secara alami berpasangan dengan eksekusi pengujian pada pipeline yang sama.
Anda menginginkan satu sumber kebenaran untuk seluruh tim. Sumber daya berada dalam proyek Apidog tempat desainer, penguji, dan penulis semuanya bekerja. CLI adalah antarmuka otomatisasi di atas ruang kerja bersama tersebut, yang cocok untuk tim yang lebih suka berkolaborasi dalam platform daripada membagikan file spesifikasi.
Unduh Apidog untuk mengikuti. Gratis untuk memulai, tidak memerlukan kartu kredit.
Keduanya bisa saling melengkapi
Ini bukan pilihan yang kaku antara salah satu atau yang lain, dan berpura-pura demikian akan melewatkan pengaturan yang paling praktis.
Alur kerja yang kuat menjalankan Redocly CLI (atau Spectral) sebagai gerbang lint di CI, menegakkan panduan gaya Anda pada setiap permintaan tarik, dan menggunakan Apidog untuk desain, mocking, eksekusi pengujian, dan dokumen yang dipublikasikan. Lakukan lint di tempat yang paling baik untuk lint, dengan set aturan sumber terbuka di terminal. Lakukan mock, pengujian, dan dokumentasikan di tempat platform paling baik. Spesifikasi mengalir di antara keduanya: lakukan lint pada file di CI, impor ke Apidog untuk semua hal selanjutnya.
Kombinasi itu memanfaatkan kekuatan sebenarnya dari setiap alat alih-alih memaksa satu alat untuk melakukan pekerjaan alat lainnya.
FAQ
Apakah Apidog CLI memiliki perintah lint dengan aturan kustom seperti Redocly?
Tidak. Apidog memvalidasi struktur definisi saat Anda mengimpornya, tetapi tidak ada perintah apidog lint dan tidak ada cara untuk membuat aturan panduan gaya kustom melalui CLI. Untuk linting yang dapat dikonfigurasi dan mengutamakan kode, gunakan Redocly CLI atau Spectral.
Bisakah Redocly CLI menjalankan pengujian API di CI?
Tidak. Redocly CLI melakukan lint, bundel, pisah, gabung, dan membangun dokumen. Ia tidak menjalankan pengujian API dan tidak menghosting server tiruan. Untuk eksekusi pengujian tanpa kepala dengan laporan JUnit dan HTML, gunakan apidog run.
Apakah Apidog sumber terbuka seperti Redocly CLI?
Tidak. Redocly CLI dan Spectral adalah sumber terbuka. Apidog adalah freemium: CLI gratis untuk diinstal dari npm, tetapi beroperasi terhadap akun dan proyek Apidog daripada sebagai perangkat lunak sumber terbuka sepenuhnya.
Saya menggunakan swagger-cli untuk validasi dan bundel. Ke mana saya harus beralih?
Kedua alat mencakupnya. Redocly CLI adalah penerus swagger-cli yang ditunjuk, dengan redocly lint (konfigurasi aturan spec untuk validasi sederhana) dan redocly bundle. Apidog mencakup hal yang sama melalui apidog import (validasi) dan apidog export (bundel, dengan peningkatan versi OpenAPI opsional), serta menambahkan mocking, pengujian, dan dokumen di ruang kerja yang sama.