flasgger/flasgger

Authorization Header + UI input view

Open

#47 opened on 2017年1月1日

GitHub で見る
 (4 comments) (5 reactions) (0 assignees)Python (3,435 stars) (500 forks)batch import
enhancementhacktoberfesthelp wanted

説明

Anyone can help me with how to implement custom headers e.g. "Authorization header" in requests + adding UI element for it with flasgger? I need to use JWT with some of the endpoints. I was able to achieve this by modifying flasgger source code, but that shouldn't be the way!

コントリビューターガイド

技術スタック
pythonflask
領域
apibackend
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Familiarity with FlaskUnderstanding of JWTBasic knowledge of Flasgger internals
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
35
調査方針
The issue requests adding support for custom authorization headers (e.g., JWT) in Swagger UI via Flasgger. Currently, the user had to modify source code to achieve this, suggesting the feature is absent. To implement, explore Flasgger's view functions (e.g., apispec/ext.py, flask swagger.py) to see how request headers are parsed. Look at the Swagger UI configuration object in flasgger/ui.py to add a new input field for headers. Consider adding a configuration option like 'headers' in the Swagger spec that automatically adds an Authorization header field to the UI. Also review how existing parameters are passed to Swagger UI's `authorization` or custom header injection.