Last active
April 7, 2021 11:12
-
-
Save serverabuse/ca7b4b1c647bc776c69d9fe6fe8f868c to your computer and use it in GitHub Desktop.
swagger-yaml-to-html.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/python | |
""" | |
Usage: | |
python swagger-yaml-to-html.py < /path/to/api.yaml > doc.html | |
""" | |
import yaml, json, sys | |
TEMPLATE = """ | |
<!DOCTYPE html> | |
<html lang="en"> | |
<head> | |
<meta charset="UTF-8"> | |
<title>Swagger UI</title> | |
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet"> | |
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.2.2/swagger-ui.css" > | |
<style> | |
html | |
{ | |
box-sizing: border-box; | |
overflow: -moz-scrollbars-vertical; | |
overflow-y: scroll; | |
} | |
*, | |
*:before, | |
*:after | |
{ | |
box-sizing: inherit; | |
} | |
body { | |
margin:0; | |
background: #fafafa; | |
} | |
</style> | |
</head> | |
<body> | |
<div id="swagger-ui"></div> | |
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.2.2/swagger-ui-bundle.js"> </script> | |
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.2.2/swagger-ui-standalone-preset.js"> </script> | |
<script> | |
window.onload = function() { | |
var spec = %s; | |
// Build a system | |
const ui = SwaggerUIBundle({ | |
spec: spec, | |
dom_id: '#swagger-ui', | |
deepLinking: true, | |
presets: [ | |
SwaggerUIBundle.presets.apis, | |
SwaggerUIStandalonePreset | |
], | |
plugins: [ | |
SwaggerUIBundle.plugins.DownloadUrl | |
], | |
layout: "StandaloneLayout" | |
}) | |
window.ui = ui | |
} | |
</script> | |
</body> | |
</html> | |
""" | |
spec = yaml.load(sys.stdin) | |
sys.stdout.write(TEMPLATE % json.dumps(spec)) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hello, i used this file, it did a good job, thanks.
Is there a way to influence the HTML output file
i need the text field for "host" to be an input field, so i can insert different urls
is that even possible?