peragaan api

Menampilkan informasi tentang titik akhir REST API Proksi Dev.

Sinopsis

devproxy api show [options]

Options:
  --output <format>   Output format: text|json (default: text)
  -h, --help          Show help

Penggunaan

devproxy api show

Opsi

Nama	Deskripsi	Nilai yang diizinkan	Default
--output <format>	Format keluaran	text, json	text
-?, -h, --help	Perlihatkan bantuan dan informasi penggunaan	n/a	n/a

Contoh

Perlihatkan informasi API Proksi Dev

devproxy api show

Mendapatkan informasi API sebagai JSON

devproxy api show --output json

Komentar

Dev Proxy mengekspos REST API terautentikasi pada http://{api-ip-address}:{api-port} (default http://127.0.0.1:8897). Semua titik akhir memerlukan token pembawa instans di Authorization header permintaan. Untuk mengambil token, gunakan perintah token api .

Perintah mencantumkan api show URL dasar API, persyaratan autentikasi, dan titik akhir REST API yang tersedia. Dengan --output json, ini juga mencakup pola file token. URL dasar mencerminkan alamat API dan port yang dikonfigurasi. Untuk mendapatkan URL API aktual dari instans yang sedang berjalan, misalnya saat Anda menggunakan --api-port 0, gunakan perintah status . API tersedia saat Dev Proxy sedang berjalan. Gunakan CLI untuk operasi siklus hidup (mulai, hentikan, konfigurasikan), dan gunakan REST API untuk operasi runtime (status proksi, perekaman, manajemen tiruan).

Titik akhir berikut tersedia:

Metode	Titik akhir	Deskripsi
GET	/proxy	Mendapatkan status proksi
POST	/proxy	Memperbarui status proksi (misalnya, memulai atau menghentikan perekaman)
POST	/proxy/mockRequest	Mengirim permintaan tiruan
POST	/proxy/stopProxy	Hentikan proksi
POST	/proxy/jwtToken	Membuat JSON Web Token (JWT)
GET	/proxy/rootCertificate	Mendapatkan sertifikat akar
GET	/proxy/logs	Mendapatkan log Proksi Dev (hanya mode yang dilepaskan)

Untuk referensi API lengkap, lihat API Proksi.