Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add api-key header to oas document (configurable) #102

Merged
merged 1 commit into from
Jan 18, 2024
Merged

add api-key header to oas document (configurable) #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@
"LOG_LEVEL": "DEBUG",
"DEBUG": "true",
"MAX_SIZE_REQUEST_BODY": "5000000",
"CORS_ALLOW_ORIGINS": "*"
"CORS_ALLOW_ORIGINS": "*",
"API_KEY_IN_OAS": "true",
"EXAMPLE_API_KEY": "FOOBAR"
},
"jinja": true,
"justMyCode": false
Expand Down
10 changes: 10 additions & 0 deletions src/coordinate_transformation_api/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,16 @@ class AppSettings(BaseSettings):
default=False,
description="enable access log, defaults to False",
)
api_key_in_oas: bool = Field(
alias="API_KEY_IN_OAS",
default=False,
description="add required api key to oas document",
)
example_api_key: str | None = Field(
alias="EXAMPLE_API_KEY",
default=None,
description="default api key to expose in oas document",
)

@classmethod
def settings_customise_sources( # type: ignore # noqa: PLR0913
Expand Down
23 changes: 23 additions & 0 deletions src/coordinate_transformation_api/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,29 @@ def init_oas(crs_config) -> tuple[dict, str, str]:
oas["info"]["version"] = version("coordinate_transformation_api")
oas["components"]["schemas"]["CrsEnum"]["enum"] = available_crss
oas["components"]["schemas"]["CrsHeaderEnum"]["enum"] = available_crss_uri

if app_settings.api_key_in_oas:
api_key_header_def = {
"APIKeyHeader": {
"type": "apiKey",
"in": "header",
"name": "apikey",
}
}
security: dict = {"security": [{"APIKeyHeader": []}]}
if app_settings.example_api_key is not None:
api_key_description = f"\n\nDemo API key is `{app_settings.example_api_key}` en is bedoeld voor exploratief gebruik van de API. "
oas["info"]["description"] = (
oas["info"]["description"] + api_key_description
)

oas["components"]["securitySchemes"] = api_key_header_def

for path in oas["paths"]:
if path != "/openapi":
for op in oas["paths"][path]:
oas["paths"][path][op] = oas["paths"][path][op] | security

api_title = oas["info"]["title"]
return (oas, api_title, oas["info"]["version"])

Expand Down