feat: new scalar UI provider to provide beautiful UI to blacksheep de…#531
Merged
RobertoPrevato merged 1 commit intoNeoteroi:mainfrom Apr 27, 2025
Merged
feat: new scalar UI provider to provide beautiful UI to blacksheep de…#531RobertoPrevato merged 1 commit intoNeoteroi:mainfrom
RobertoPrevato merged 1 commit intoNeoteroi:mainfrom
Conversation
…fault UI providers
Member
|
Thanks for the PR, @arthurbrenno. It looks interesting and I am willing to merge, but I wish to review Scalar before merging. |
Contributor
Author
|
Np. Thanks! |
Contributor
|
hi, I think creating a separate file named <!DOCTYPE html>
<html>
<head>
<title>##PAGE_TITLE##</title>
<link rel="icon" href="##FAVICON_URL##" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="##CSS_URL##" rel="stylesheet">
</head>
<body>
<div id="app"></div>
<script src="##JS_URL##"></script>
<script>
Scalar.createApiReference('#app', {
url: '##SPEC_URL##',
})
</script>
</body>
</html>Then change the function def get_openapi_ui_html(self, options: UIOptions) -> str:
"""
Returns the HTML response to serve the Scalar API Reference UI.
Parameters:
options (UIOptions): Configuration options for the UI
Returns:
str: HTML content for the Scalar UI
"""
return (
get_resource_file_content("scalar_ui.html")
.replace("##PAGE_TITLE##", options.page_title)
.replace("##FAVICON_URL##", options.favicon_url)
.replace("##CSS_URL##", self.ui_files.css_url or "")
.replace("##SPEC_URL##", options.spec_url)
.replace("##JS_URL##", self.ui_files.js_url or "")
) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've added a new integration for Scalar. Scalar is one of the UI providers that provide the most beautiful UIs. I think it would be a great add to BlackSheep default UI providers. I've only changed
ui.pyfile.