OpenAPI / Swagger Belge Görüntüleyici

OpenAPI 3.0 ve Swagger 2.0 belirtimlerini (JSON/YAML) etkileşimli API belgeleri olarak görüntüleyin.

OpenAPI / Swagger Belge Görüntüleyici Hakkında — Ayrıntılı Kılavuz

Kategori: DevOps ve Standartlar %100 Tarayıcıda Yerel

OpenAPI Görüntüleyici (OpenAPI Viewer), RESTful API sözleşmelerini incelemek için geliştirilmiş istemci tarafı bir dokümantasyon okuyucusudur. Yerel Swagger UI kurulumuna veya bulut bağımlılıklarına gerek kalmadan Swagger 2.0 ve OpenAPI 3.0 / 3.1 belirtimlerini JSON veya YAML biçiminde işler.

Tüm uç noktalar için derli toplu gruplandırılmış kenar çubuğu gezintisi sunarak yolları, HTTP metotlarını (GET, POST, PUT, DELETE), başlık parametrelerini, sorgu dizgilerini, yapılandırılmış istek gövdelerini, HTTP yanıt kodlarını ve veri şemalarını görüntüler.

#openapi #swagger #api #docs #rest #yaml #json

Temel Özellikler ve Yetenekler

  • JSON ve YAML biçimindeki Swagger 2.0 ve OpenAPI 3.0 / 3.1 belirtimlerini destekler
  • Kategorilere ayrılmış uç noktaları, HTTP metotlarını ve durum kodlarını listeleyen etkileşimli kenar çubuğu
  • İç içe geçmiş veri modellerini ve özellik kısıtlamalarını gösteren derin `$ref` şema çözümlemesi
  • Özel kurumsal API sözleşmelerini güvende tutan %100 istemci tarafı çevrim dışı ayrıştırma

Nasıl Kullanılır

  1. 1

    `swagger.json` veya `openapi.yaml` metninizi yapıştırın ya da belirtim dosyasını doğrudan yükleyin.

  2. 2

    Etkileşimli görüntüleyicide işlenen yapılandırılmış API dokümantasyonuna göz atın.

  3. 3

    İstek başlıklarını, istek yükü şemalarını ve yanıt örneklerini incelemek için herhangi bir uç noktayı genişletin.

Yaygın Kullanım Alanları

  • → Özel bir Swagger UI sunucusu kurmaya gerek kalmadan arka uç API tanımlarını denetleme
  • → Elle yazılmış OpenAPI belirtimlerini geçersiz `$ref` işaretçilerine karşı mantık denetiminden geçirme
  • → API entegrasyonları sırasında ön uç mühendislerine doğru şema referansları sağlama

İlgili Araçlar

Sıkça Sorulan Sorular ve Gizlilik

Bu araç YAML belirtimlerini doğrudan okuyabilir mi?

Evet. Dahili YAML ayrıştırıcısı, hem `.yaml` hem de `.json` OpenAPI sözleşme belirtimlerini tamamen tarayıcı içinde işler.

Özel API belirtimim harici sunuculara yükleniyor mu?

Hayır. Tüm belge ayrıştırma ve şema oluşturma işlemleri yalnızca yerel tarayıcı belleğinizde yürütülür.