https://github.com/connectaman/fastapi-openapi-markdown-documentation-generator

Streamlit Application to generate FastAPI Documentation from the OpenAPI specs and convert it into a markdown API documentation
https://github.com/connectaman/fastapi-openapi-markdown-documentation-generator

api documentation fastapi markdown microservice openapi python

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/connectaman/fastapi-openapi-markdown-documentation-generator
• Owner: connectaman
• License: mit
• Created: 2024-05-07T05:23:43.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-08T03:23:35.000Z (8 months ago)
• Last Synced: 2024-05-08T06:33:44.074Z (8 months ago)
• Topics: api, documentation, fastapi, markdown, microservice, openapi, python
• Language: Python
• Homepage: https://fastapi-openapi-markdown-documentation-generator-d96hc549nb58e.streamlit.app/
• Size: 7.81 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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:

```bash

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

```

2. Install the dependencies:

```bash

pip install -r requirements.txt

```

### Usage

1. Run the Streamlit app:

```bash

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.