Membuat Proyek API Baru

Di Apidog, setiap proyek berkorespondensi dengan sebuah file API Specification atau OpenAPI Specification (OAS). Anda dapat membuat proyek API baru atau mengimpor proyek yang sudah ada dari bagian Home > My Teams > Projects pada aplikasi Apidog.

Membuat Proyek

Di jendela utama, klik tombol + New Project di kanan atas.

Pilih kategori proyek di bagian atas: General atau gRPC.

General: Pilih ini untuk sebagian besar API. Kategori ini mendukung HTTP(s), WebSocket, Socket.IO, Webhook, Markdown, dan lainnya.

gRPC: Pilih ini untuk API yang menggunakan protokol gRPC. Pelajari lebih lanjut tentang proyek gRPC.

(Jika Anda memilih General) Pilih mode proyek yang Anda inginkan. Apidog menawarkan dua alur kerja yang berbeda: General Mode dan Spec-first Mode. Ikuti instruksi di bawah ini berdasarkan pilihan Anda.

General Mode

Paling sesuai untuk alur kerja berbasis GUI. Mode ini mencakup Visual API Editor untuk desain API, debugging, pengujian, dan dokumentasi yang dibuat secara otomatis. Anda juga dapat mencadangkan OpenAPI Specs yang dibuat otomatis ke repositori Git.

Pilih General Mode.

Masukkan nama untuk proyek Anda.

(Opsional) Centang opsi Including Examples untuk membuat proyek dengan data sampel dari contoh PetStore.

(Untuk tim dengan banyak pengguna) Atur izin untuk anggota tim lain selama pembuatan proyek. Untuk informasi lebih lanjut, lihat pengaturan izin anggota.

(Opsional) Atur Project language. Untuk informasi lebih lanjut, lihat pengaturan bahasa.

Spec-first Mode (Beta)

Ideal untuk alur kerja Git native. Rancang spesifikasi API menggunakan OpenAPI Spec Editor (file YAML/JSON) dan pertahankan sinkronisasi dua arah yang lancar dengan repositori Git Anda.

Pilih Spec-first Mode.

Gulir ke bawah ke bagian Connect with Git Repository.

Klik Connect to GitHub atau Connect to GitLab SaaS untuk menautkan repositori Anda dan mengonfigurasi pengaturan sinkronisasi Anda.

(Untuk tim dengan banyak pengguna) Atur izin untuk anggota tim lain. Untuk informasi lebih lanjut, lihat pengaturan izin anggota.

Pelajari Lebih Lanjut

Untuk pembahasan mendalam tentang workspace Specs berbasis kode, penguraian direktori secara real-time, dan alur kerja commit Git, lihat panduan terperinci kami tentang Spec-first Mode.

Mengimpor API yang Sudah Ada

Jika Anda sudah memiliki API Specification, Anda dapat memulai proses impor baik dari bagian Team > Projects dengan memilih Import Project, maupun langsung di dalam proyek yang sudah ada dengan mengeklik tanda ➕ besar dan memilih Import. Ini ideal untuk memigrasikan data API yang sudah ada ke Apidog.

Klik "Import Project".

Pilih jenis data yang ingin Anda impor.

Unggah file atau tempel URL data (hanya format OpenAPI/Swagger).

Apidog akan secara otomatis mengenali dan menguraikan konten berdasarkan format yang dipilih. Anda akan dapat mempratinjau data sebelum mengimpornya. Pilih apa yang ingin Anda impor dan konfigurasikan logika impor. Kemudian konfirmasikan untuk membuat dan mengimpor proyek.

Setelah impor selesai, proyek baru Anda akan siap digunakan.

Pelajari Lebih Lanjut

Untuk informasi terperinci tentang proses impor, lihat Panduan Impor.

Membuat Proyek API Baru

Membuat Proyek#

General Mode#

Spec-first Mode (Beta)#

Mengimpor API yang Sudah Ada#

Membuat Proyek

General Mode

Spec-first Mode (Beta)

Mengimpor API yang Sudah Ada