API göster

Dev Proxy REST API uç noktaları hakkındaki bilgileri görüntüler.

Özet

devproxy api show [options]

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

Usage

devproxy api show

Options

İsim Description İzin verilen değerler Varsayılan
--output <format> Çıkış biçimi text, json text
-?, -h, --help Yardım ve kullanım bilgilerini gösterme Yok Yok

Örnekler

Geliştirme Proxy'si API'si bilgilerini gösterme

devproxy api show

API bilgilerini JSON olarak alma

devproxy api show --output json

Açıklamalar

Dev Proxy, (varsayılan bağlantı noktası8897) konumunda http://127.0.0.1:{api-port} kimliği doğrulanmış bir REST API'yi kullanıma sunar. Tüm uç noktalar, istek üst bilgisinde örnek taşıyıcı belirtecini Authorization gerektirir. Belirteci almak için api belirteci komutunu kullanın.

Komut API temel URL'sini api show , kimlik doğrulama gereksinimlerini, belirteç dosyası desenini ve kullanılabilir REST API uç noktalarını listeler. Geliştirme Proxy'si çalışırken API kullanılabilir. Yaşam döngüsü işlemleri (başlatma, durdurma, yapılandırma) için CLI kullanın ve çalışma zamanı işlemleri (ara sunucu durumu, kayıt, sahte yönetim) için REST API'yi kullanın.

Aşağıdaki uç noktalar kullanılabilir:

Yöntem Bitiş noktası Description
GET /proxy Proxy durumunu alma
POST /proxy Proxy durumunu güncelleştirme (örneğin, kaydı başlatma veya durdurma)
POST /proxy/mockRequest Sahte istek gönderme
POST /proxy/stopProxy Ara sunucuyu durdurma
POST /proxy/jwtToken JSON Web Belirteci (JWT) oluşturma
GET /proxy/rootCertificate Kök sertifikayı alma
GET /proxy/logs Geliştirme Proxy günlüklerini alma (yalnızca ayrılmış mod)

Tam API başvurusu için bkz. Proxy API.