fastapi-openapi-markdown-documentation-generator 📜

Streamlit Application to generate FastAPI Documentation from the OpenAPI specs and convert it into a markdown API documentation

Try it out : https://fastapi-openapi-markdown-documentation-generator-d96hc549nb58e.streamlit.app

Overview

This Streamlit-based application allows you to generate API documentation from an OpenAPI JSON string. It provides a user-friendly interface for generating documentation quickly and easily.

Features

• Paste or upload OpenAPI JSON
• Generate Markdown documentation
• View and download documentation

Installation

1. Clone the repository:

git clone https://github.com/connectaman/fastapi-openapi-docs-generator.git

2. Install the dependencies:

pip install -r requirements.txt

Usage

1. Run the Streamlit app:

streamlit run app.py

2. Paste your OpenAPI JSON or upload a JSON file.
3. Click the "Generate Documentation" button to generate Markdown documentation.
4. View and download 📥 the generated documentation.