This plugin provides an easy way to render a beautiful API reference based on a OpenAPI/Swagger file with FastAPI.
pip install scalar-fastapi
FastAPI makes it super easy to enable scalar with their out of the box OpenAPI support
from fastapi import FastAPI
from scalar_fastapi import get_scalar_api_reference
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
@app.get("/scalar", include_in_schema=False)
async def scalar_html():
return get_scalar_api_reference(
openapi_url=app.openapi_url,
title=app.title,
)
Currently available configuration options are listed below.
layout (default Layout.MODERN)show_sidebar (defualt true)hide_download_button (default false)hide_models (default false)dark_mode (default true)search_hot_key (default SearchHotKey.K)hidden_clients (default [])servers (default [])default_open_all_tags (default false)FAQs
This plugin provides an easy way to render a beautiful API reference based on a OpenAPI/Swagger file with FastAPI.
We found that scalar-fastapi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.