3.3 KiB

Raw Blame History

Swagger UI'yi Yapılandırın

Bazı ek Swagger UI parametrelerini yapılandırabilirsiniz.

Bunları yapılandırmak için, FastAPI() uygulama nesnesini oluştururken ya da get_swagger_ui_html() fonksiyonuna swagger_ui_parameters argümanını verin.

swagger_ui_parameters, Swagger UI'ye doğrudan iletilecek yapılandırmaları içeren bir dict alır.

FastAPI, Swagger UI'nin ihtiyaç duyduğu şekilde JavaScript ile uyumlu olsun diye bu yapılandırmaları JSON'a dönüştürür.

Syntax Highlighting'i Devre Dışı Bırakın

Örneğin, Swagger UI'de syntax highlighting'i devre dışı bırakabilirsiniz.

Ayarları değiştirmeden bırakırsanız, syntax highlighting varsayılan olarak etkindir:

Ancak syntaxHighlight değerini False yaparak devre dışı bırakabilirsiniz:

{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *}

...ve ardından Swagger UI artık syntax highlighting'i göstermeyecektir:

Temayı Değiştirin

Aynı şekilde, "syntaxHighlight.theme" anahtarıyla (ortasında bir nokta olduğuna dikkat edin) syntax highlighting temasını ayarlayabilirsiniz:

{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *}

Bu yapılandırma, syntax highlighting renk temasını değiştirir:

Varsayılan Swagger UI Parametrelerini Değiştirin

FastAPI, çoğu kullanım senaryosu için uygun bazı varsayılan yapılandırma parametreleriyle gelir.

Şu varsayılan yapılandırmaları içerir:

{* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *}

swagger_ui_parameters argümanında farklı bir değer vererek bunların herhangi birini ezebilirsiniz (override).

Örneğin deepLinking'i devre dışı bırakmak için swagger_ui_parameters'a şu ayarları geçebilirsiniz:

{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *}

Diğer Swagger UI Parametreleri

Kullanabileceğiniz diğer tüm olası yapılandırmaları görmek için, resmi Swagger UI parametreleri dokümantasyonunu okuyun.

Yalnızca JavaScript Ayarları

Swagger UI ayrıca bazı yapılandırmaların yalnızca JavaScript nesneleri olmasına izin verir (örneğin JavaScript fonksiyonları).

FastAPI, bu yalnızca JavaScript olan presets ayarlarını da içerir:

presets: [
    SwaggerUIBundle.presets.apis,
    SwaggerUIBundle.SwaggerUIStandalonePreset
]

Bunlar string değil, JavaScript nesneleridir; dolayısıyla bunları Python kodundan doğrudan geçemezsiniz.

Böyle yalnızca JavaScript yapılandırmalarına ihtiyacınız varsa, yukarıdaki yöntemlerden birini kullanabilirsiniz: Swagger UI'nin tüm path operation'larını override edin ve ihtiyaç duyduğunuz JavaScript'i elle yazın.

3.3 KiB Raw Blame History Unescape Escape