swaggerizer 0.1.1__py3-none-any.whl

swaggerizer/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["__version__"]
+__version__ = "0.1.0"
+

swaggerizer/cli.py

@@ -0,0 +1,121 @@
+import argparse, os, shutil
+from .helpers.create_project import Swaggerizer
+from .helpers.html_exporter import HTMLExporter
+from .helpers.json2yaml_converter import json2YamlConverter
+from .helpers.yaml2json_converter import yaml2JsonConverter
+from .helpers.validator import validator
+
+
+def checkCreateOutputDir(output_arg):
+    # Create output directory if needed
+    output_dir = os.path.dirname(output_arg)
+    if output_dir and not os.path.exists(output_dir):
+        os.makedirs(output_dir)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Swaggerize your API documentation.",
+        formatter_class=argparse.RawTextHelpFormatter
+    )
+    parser.add_argument(
+        "operation",
+        metavar="OPERATION",
+        choices=["create", "export", "json2yaml", "yaml2json", "validate"],
+        help=("Available operations:\n"
+              "    create = Create new modularized OpenAPI docs project\n"
+              "    export = Export OpenAPI YAML file as HTML\n"
+              "    json2yaml = Convert OpenAPI JSON file to YAML\n"
+              "    yaml2json = Convert OpenAPI YAML file to JSON\n"
+              "    validate = Validate basic JSON or YAML format"
+             )
+    )
+    parser.add_argument(
+        "-i", "--input",
+        metavar="IN_FILE",
+        default=None, 
+        help=("Input file or path. Default value per operation:\n"
+              "    create = './openapi.yaml'\n"
+              "    export = './openapi.yaml'\n"
+              "    json2yaml = './openapi.json'\n"
+              "    yaml2json = './openapi.yaml'"
+             )
+    )
+    parser.add_argument(
+        "-o", "--output",
+        metavar="OUT_FILE",
+        default=None,
+        help=("Output file or path. Default value per operation:\n"
+              "    export = '{IN_FILE}.html'\n"
+              "    json2yaml = '{IN_FILE}.yaml'\n"
+              "    yaml2json = '{IN_FILE}.json'"
+             )
+
+    )
+    parser.add_argument(
+        "-t", "--type",
+        metavar="FILE_TYPE",
+        default=None,
+        choices=["json", "yaml"], 
+        help=("File type for validate operation. Omit to get type\n"
+              "from file extension. Possible values:\n"
+              "    json = Validate basic JSON format.\n"
+              "    yaml = Validate basic YAML format."
+              )
+    )
+
+    # Parse arguments
+    args = parser.parse_args()
+
+    # Handle the requested operation
+    if args.operation == "create":
+        # Define default input 
+        args.input = args.input or "openapi.yaml"
+
+        # Swaggerize it
+        project = Swaggerizer(args.input)
+        project.create()
+
+    elif args.operation == "export":
+        # Define default input 
+        args.input = args.input or "openapi.yaml"
+
+        # Make sure output dir exists if specified
+        if args.output:
+            checkCreateOutputDir(args.output)
+
+        # Export the HTML
+        exporter = HTMLExporter(args.input, args.output)
+        exporter.export()
+
+    elif args.operation == "json2yaml":
+        # Define default input 
+        args.input = args.input or "openapi.json"
+
+        # Make sure output dir exists if specified
+        if args.output:
+            checkCreateOutputDir(args.output)
+
+        # Convert the JSON to YAML
+        converter = json2YamlConverter(args.input, args.output)
+        converter.convert()
+
+    elif args.operation == "yaml2json":
+        # Define default input 
+        args.input = args.input or "openapi.yaml"
+
+        # Make sure output dir exists if specified
+        if args.output:
+            checkCreateOutputDir(args.output)
+
+        # Convert the YAML to JSON
+        converter = yaml2JsonConverter(args.input, args.output)
+        converter.convert()
+
+    elif args.operation == "validate":
+        # Define default input 
+        args.input = args.input or "openapi.yaml"
+
+        # Validate the file
+        validator.validate(args.input, args.type)
+

swaggerizer/files/customizer.css

@@ -0,0 +1,70 @@
+/************************************************************************/
+/* top header */
+/************************************************************************/
+
+.swagger-ui .topbar {
+	/* header bar */
+	/* display: none; */
+	background-color: #353535;
+	padding: 5px 0;
+}
+
+.topbar .download-url-wrapper {
+	/* search input */
+	visibility: hidden;
+}
+
+.topbar .topbar-wrapper > .link > img {
+	/* default logo */
+	display: none;
+}
+
+.topbar .topbar-wrapper > .link::before {
+	/* custom logo (as base64-encoded SVG) */
+    	content: url("data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyNy41LjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCA2NDAgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA2NDAgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+DQo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPg0KCS5zdDB7ZmlsbDojMDA2MDk4O30NCjwvc3R5bGU+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMzkyLjgsMS4yYy0xNy00LjktMzQuNyw1LTM5LjYsMjJsLTEyOCw0NDhjLTQuOSwxNyw1LDM0LjcsMjIsMzkuNnMzNC43LTUsMzkuNi0yMmwxMjgtNDQ4DQoJQzQxOS43LDIzLjgsNDA5LjgsNi4xLDM5Mi44LDEuMkwzOTIuOCwxLjJ6IE00NzMuNCwxMjEuM2MtMTIuNSwxMi41LTEyLjUsMzIuOCwwLDQ1LjNsODkuMyw4OS40bC04OS40LDg5LjQNCgljLTEyLjUsMTIuNS0xMi41LDMyLjgsMCw0NS4zczMyLjgsMTIuNSw0NS4zLDBsMTEyLTExMmMxMi41LTEyLjUsMTIuNS0zMi44LDAtNDUuM2wtMTEyLTExMkM1MDYuMSwxMDguOSw0ODUuOCwxMDguOSw0NzMuNCwxMjEuMw0KCUw0NzMuNCwxMjEuM3ogTTE2Ni43LDEyMS4zYy0xMi41LTEyLjUtMzIuOC0xMi41LTQ1LjMsMGwtMTEyLDExMmMtMTIuNSwxMi41LTEyLjUsMzIuOCwwLDQ1LjNsMTEyLDExMmMxMi41LDEyLjUsMzIuOCwxMi41LDQ1LjMsMA0KCXMxMi41LTMyLjgsMC00NS4zTDc3LjMsMjU2bDg5LjQtODkuNEMxNzkuMiwxNTQuMSwxNzkuMiwxMzMuOCwxNjYuNywxMjEuM0wxNjYuNywxMjEuM3oiLz4NCjwvc3ZnPg0K");
+    	display: inline-block;
+    	width: 50px;
+    	height: 50px;
+    	margin-top: 10px;
+}
+
+.topbar .topbar-wrapper > .link:after {
+	/* custom header text */
+	content: "swaggerized";
+	font-style: italic;
+	margin-left: 15px;
+    	font-weight: 400;
+    	font-size: 30px;
+    	line-height: 38px;
+	color: #CCAF46;
+}
+
+/************************************************************************/
+/* content area */
+/************************************************************************/
+
+.swagger-ui .info {
+	/* main container */
+	margin: 35px 0; 
+}
+
+.swagger-ui .info h2.title {
+	/* page title */
+}
+
+.swagger-ui .info h2.title span > small:first-of-type {
+	/* title pill 1 */
+	display: none;
+}
+
+.swagger-ui .info h2.title span > small:first-of-type {
+	/* title pill 1 */
+	display: none;
+}
+
+.swagger-ui .info h2.title span > small.version-stamp {
+	/* version stamp title pill */
+	display: none;
+}
+
+/* (etc...) */

swaggerizer/files/makefile

@@ -0,0 +1,17 @@
+all: test
+
+test:
+	rm -f openapi-test.yaml
+	(echo "########## AUTO-GENERATED FILE: DO NOT EDIT! ##########" >> openapi-test.yaml)
+	cat 0_intro/*.yaml >> openapi-test.yaml
+	(echo "paths:" >> openapi-test.yaml)
+	cat 1_endpoints/*.yaml >> openapi-test.yaml
+	(echo "components:" >> openapi-test.yaml)
+	cat 2_components/*.yaml >> openapi-test.yaml
+	cat 3_misc/*.yaml >> openapi-test.yaml
+
+final-build:
+	cp openapi-test.yaml ../FINAL_BUILD_TARGET
+
+clean:
+	rm -f openapi-test.yaml