Kullanıcı Kılavuzu

Swagger UI Settings

13/4/26
Swagger UI Settings

Swagger UI, uygulamanızın API’lerini görselleştirmek, test etmek ve dokümante etmek için kullanılan bir araçtır. Kuika’nın Configuration Manager modülünde bulunan Swagger UI ayarları sayesinde, API’lerinizi aktif edebilir ve erişim kontrolünü yapılandırabilirsiniz.

Swagger UI Ayarları Adımları

1. Uygulamanıza Konfigürasyon Ekleyin

  • Kuika platformuna giriş yapın.
  • Apps ekranından çalışacağınız projeyi açın.
  • Configuration Manager modülüne tıklayın.
  • Açılan ekranda konfigürasyona bir isim verin ve CREATE butonuna tıklayın.

2. Swagger UI Ayarlarını Yapılandırın

  • Yeni bir konfigürasyon oluşturduktan sonra App Settings ekranını açın.
  • Swagger UI bölümüne gidin.
  • Bu alanda aşağıdaki ayarları yapılandırabilirsiniz:
  • Use Swagger UI: Swagger UI’nin aktif olup olmayacağını belirler.
  • Swagger UI Credentials: Swagger UI erişimi için kimlik doğrulama yöntemini belirler.
  • Default: Sistem tarafından tanımlı varsayılan kimlik bilgileri kullanılır.
  • Custom: Özel kullanıcı adı ve şifre tanımlanır.
  • Custom seçildiğinde:
    • Username: Swagger UI’ye erişecek kullanıcı adı
    • Password: Swagger UI’ye erişecek şifre

3. Ayarların Test Edilmesi

  • Uygulamanın üst kısmında bulunan Preview butonunun yanındaki üç noktaya tıklayın.
  • Açılan menüden RUN butonuna tıklayın.

Swagger UI aktif ise, uygulama çalıştığında API dokümantasyon arayüzü üzerinden endpoint’ler görüntülenebilir ve test edilebilir.

Dikkat Edilmesi Gerekenler

  • Swagger UI genellikle geliştirme ve test ortamlarında kullanılmalıdır.
  • Production ortamında erişim mutlaka kısıtlanmalıdır.
  • Custom credentials kullanılması önerilir.

Bu adımları takip ederek Swagger UI ayarlarını kolayca yapılandırabilir ve API’lerinizi güvenli şekilde test edebilirsiniz.

No items found.

İlişkili diğer içerikler

No items found.

Sözlük

No items found.

Alt Başlıklar