Skip to content
Smarter by Design.Simpler for Business

Export (OpenAPI) ​

Export (OpenAPI) Nedir? ​

Export (OpenAPI), seçili host grubunun tüm sayfa tiplerini (WAF kurallarını) standart bir OpenAPI 3.0 belgesi olarak indirir. Export TR7'ye özgü bir kural listesi üretirken, bu özellik kural setini API dünyasının ortak diliyle ifade eder: belge, API dokümantasyon ve test araçlarıyla açılabilir, API ekipleriyle paylaşılabilir ve Import (OpenAPI) ile TR7'ye kayıpsız geri yüklenebilir.

Dışa Aktarma Adımları ​

  1. Araç çubuğundaki Export (OpenAPI) butonuna tıklanır. İşlem tablo seçiminden bağımsızdır; her zaman grubun tamamı aktarılır.
  2. Onay penceresi yoktur; dosya doğrudan tarayıcı tarafından indirilir. İşlem sürerken buton simgesi dönen bir simgeye dönüşür ve araç çubuğundaki diğer işlemler geçici olarak pasifleşir.

İndirilen dosyanın adı, korunan vService adı ile host grubu adından, openapi ekinden ve tarih-saat damgasından oluşur (boşluklar _ ile değiştirilir): örneğin Web_Servisi-DEFAULT_HOST_GROUP_openapi_20260828_1530.json. Çıktı her zaman JSON biçimindedir; YAML çıktısı üretilmez (Import (OpenAPI) ise YAML dosyaları da kabul eder).

Dışa aktarma salt okuma bir işlemdir; WAF yapılandırması değişmez.

Üretilen Belge ​

Belge, geçerli bir OpenAPI 3.0 tanımıdır; her sayfa tipi paths altında bir path olarak yer alır:

  • Path'ler: Exact path'ler olduğu gibi yazılır. Glob path'lerdeki her *, sırayla {param1}, {param2} biçiminde bir şablon parametresine çevrilir: örneğin /api/v*/login kuralı belgede /api/v{param1}/login olarak görünür.
  • Operasyonlar: Kuralın Allowed Methods listesindeki metotlardan standart HTTP metotlarına karşılık gelenler, path'in operasyonları olarak yazılır. Metot kısıtı olmayan kurallar belgede temsilen tek bir get operasyonuyla görünür.
  • Parametre ve gövde şemaları: Kuralın Check Fields denetimlerinden sorgu ve başlık alanları parameters olarak (zorunlu alanlar required işaretiyle), form/JSON/XML gövde alanları ise requestBody şemaları olarak yazılır; alanlara tanımlı uzunluk ve desen kısıtları şemaya yansıtılır.
  • Any Paths: Catch-all kuralı paths altına girmez; belgenin TR7'ye özel bölümünde taşınır.

Kayıpsız geri yükleme, kayıplı standart görünüm

Belge, TR7'ye özel bir alanda (x-tr7-waf) her kuralın tam yapılandırmasını da taşır; bu sayede Import (OpenAPI) ile TR7'ye geri yükleme kayıpsızdır. Standart OpenAPI alanları ise kuralların yalnızca bir bölümünü yansıtır: Path Length, Path Depth, OWASP taraması gibi TR7'ye özgü denetimler standart görünümde yer almaz. Belgeyi üçüncü parti bir araçla işleyip yeniden içe aktarmak bu nedenle bilgi kaybına yol açabilir.

Düz Export ile Karşılaştırma ​

ExportExport (OpenAPI)
BiçimTR7'ye özgü JSON kural listesiStandart OpenAPI 3.0 belgesi
AmaçYedekleme, TR7'ler arası taşımaAPI araçlarıyla paylaşım + TR7'ye geri yükleme
Geri yüklemeImport (tam değiştirme)Import (OpenAPI) (birleştirme)

Operasyonel En İyi Uygulamalar ​

  • Yedekleme için düz Export tercih edilmeli. Kural setini birebir yedekleyip geri yüklemenin standart yolu Export + Import çiftidir; OpenAPI biçimi paylaşım ve API araçlarıyla birlikte çalışma içindir.
  • Paylaşmadan önce içerik bilinmeli. Belge, standart API tanımının yanında TR7'ye özel bölümlerde WAF kurallarının tüm ayrıntılarını da taşır; kurum dışıyla paylaşılacaksa bu bölümlerin de paylaşılmış olacağı göz önünde bulundurulmalıdır.