actions-marketplace-validations/FastAPI OpenAPI Specs Generator

Generates the OpenAPI specs file for a FastAPI project.

Trust Signals

name	description	required	default
installDependencies	Command to use to install dependencies before running FastAPI application. This command gets ran as a standard shell command.	no	pip install -r requirements.txt
moduleDir	The directory in which the FastAPI Python app lives. This should be the first folder in your project with a '__init__.py' file. Needed to do 'from project import app' in subsequent steps.	yes	—
fileName	The file in which your FastAPI application gets initialized from.	yes	main.py
appName	The name of the FastAPI object inside your '{moduleDir}/{fileName}.py'. This is used to do 'from {moduleDir}.{fileName} import {appName}'.	yes	app
fastapiVersioning	Only use this if your application uses the 'fastapi-versioning' package. If the 'fastapi-versioning' is being used each version of your application has its own individual FastAPI app that is ran in conjunction. This variable defines which FastAPI API to use to generate the client. Use the package's VersionedFastAPI.prefix_format string, something like 'v{number}' typically (e.g. 'v1').	no	—
outputName	The name of the output file. Do not include extension.	yes	openapi
outputExtension	Output extension. May either be yaml or json.	yes	yaml

no outputs