Metadata-Version: 2.1
Name: scalar-fastapi
Version: 1.0.2
Summary: This plugin provides an easy way to render a beautiful API reference based on a OpenAPI/Swagger file with FastAPI.
Home-page: https://github.com/scalar/scalar
Author: Marc Laventure
Author-email: marc@scalar.com
Description-Content-Type: text/markdown

# Scalar FastAPI API Reference Plugin

![fastapi](fastapi.png)

## Installation

```bash
pip install scalar-fastapi
```

## Usage

FastAPI makes it super easy to enable scalar with their out of the box OpenAPI support

```python
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,
    )

```
