Skip to content

Instantly share code, notes, and snippets.

@Kludex

Kludex/redoc.py

Last active October 8, 2024 07:14
Show Gist options
  • Save Kludex/c7a1ad97e6fcd664dee972a89fd0cec8 to your computer and use it in GitHub Desktop.
Save Kludex/c7a1ad97e6fcd664dee972a89fd0cec8 to your computer and use it in GitHub Desktop.
Download ZIP
Export FastAPI ReDoc to HTML
Raw
redoc.py
"""
Script to export the ReDoc documentation page into a standalone HTML file.
Created by https://github.com/pawamoy on https://github.com/Redocly/redoc/issues/726#issuecomment-645414239
"""
import json
from my_app.app import app
HTML_TEMPLATE = """<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>My Project - ReDoc</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" href="https://fastapi.tiangolo.com/img/favicon.png">
<style>
body {
margin: 0;
padding: 0;
}
</style>
<style data-styled="" data-styled-version="4.4.1"></style>
</head>
<body>
<div id="redoc-container"></div>
<script src="https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"> </script>
<script>
var spec = %s;
Redoc.init(spec, {}, document.getElementById("redoc-container"));
</script>
</body>
</html>
"""
if __name__ == "__main__":
with open(f"api-docs-my-project.html", "w") as fd:
print(HTML_TEMPLATE % json.dumps(app.openapi()), file=fd)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment