virajkanwade / fastapi_swagger2

Swagger2 support for fastapi

fastapi_swagger2

Swagger2 support for FastAPI

---

Reason behind this library:

Few API GW services like Google Cloud API GW still support only Swagger 2.0 spec. Since FastAPI only supports OAS3, it is a challenge. Converting from OAS3 to Swagger 2.0 requires some manual steps which would hinder CI/CD.

---

Requirements

Python 3.8+

FastAPI 0.79.0+

Installation

$ pip install fastapi_swagger2

Example

from typing import Union

from fastapi import FastAPI
from fastapi_swagger2 import FastAPISwagger2

app = FastAPI()
FastAPISwagger2(app)


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}

This adds following endpoints:

• http://localhost:8000/swagger2.json
• http://localhost:8000/swagger2/docs
• http://localhost:8000/swagger2/redoc

Generate spec for CI/CD

import os

import yaml

from app.main import app

URL = os.environ["CLOUD_RUN_URL"]

app.servers.append(URL)

spec = app.swagger2()
spec['x-google-backend'] = {'address': URL}

print(yaml.dump(spec))

Development

$ pip install "/path/to/fastapi_swagger2/repo[test,all]"

fastapi_swagger2's Issues

Optional SecurityDefinitions could use default

https://github.com/virajkanwade/fastapi_swagger2/blob/fastapi_0.100.0/src/fastapi_swagger2/models.py#L330

I think securityDefinitions: Optional[Dict[str, Union[SecurityScheme, Reference]]] could use a default of = None to avoid pydantic validation errors when not present.