Merge branch 'add_commands' into 2.x

# Conflicts:
#	flask_openapi3/openapi.py
#	setup.py

Author: luolingchun

docs/OpenAPI/Specification.md

@@ -1,5 +1,47 @@
+## Specification
+
 If you need the complete Specification(json) , go to http://127.0.0.1:5000/openapi/openapi.json
 
+**command: `flask openapi`**
+
+*New in v2.0.0*
+
+The `flask openapi` command will export the OpenAPI Specification to console when you execute the command:
+
+```
+flask openapi
+```
+
+Execute `flask openapi --help` for more information:
+
+```
+flask openapi --help
+
+Usage: flask openapi [OPTIONS]
+
+  Export the OpenAPI Specification to console or a file
+
+Options:
+  -o, --output PATH               The output file path.
+  -f, --format [json|yaml|markdown]
+                                  The output file format.
+  -i, --indent INTEGER            The indentation for JSON dumps.
+  -a, --ensure_ascii              Ensure ASCII characters or not. Defaults to
+                                  False.
+  --help                          Show this message and exit.
+
+```
+
+!!! info
+
+    You need to manually install `yaml` using pip:
+    ```bash
+    pip install flask-openapi3[yaml]
+    
+    # or
+    pip install yaml
+    ```
+
 ## doc_ui
 
 You can pass `doc_ui=False` to disable the `OpenAPI spec` when init `OpenAPI `.

flask_openapi3/commands.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+# @Author  : llc
+# @Time    : 2022/4/16 14:21
+import json
+
+from flask import current_app
+from flask.cli import click
+from flask.cli import with_appcontext
+
+from .markdown import openapi_to_markdown
+
+
+@click.command(name='openapi')
+@click.option('--output', '-o', type=click.Path(), help='The output file path.')
+@click.option('--format', '-f', type=click.Choice(['json', 'yaml', 'markdown']), help='The output file format.')
+@click.option('--indent', '-i', type=int, help='The indentation for JSON dumps.')
+@click.option('--ensure_ascii', '-a', is_flag=True, help='Ensure ASCII characters or not. Defaults to False.')
+@with_appcontext
+def openapi_command(output, format, indent, ensure_ascii):
+    """Export the OpenAPI Specification to console or a file"""
+    if hasattr(current_app, 'api_doc'):
+        obj = current_app.api_doc
+        if format == 'yaml':
+            import yaml
+            openapi = yaml.safe_dump(obj)
+        elif format == 'markdown':
+            openapi = openapi_to_markdown(obj)
+        else:
+            openapi = json.dumps(obj, indent=indent, ensure_ascii=ensure_ascii)
+        if output:
+            with open(output, 'w', encoding='utf8') as f:
+                f.write(openapi)
+            click.echo(f"Saved to {output}.")
+        else:
+            click.echo(openapi)

flask_openapi3/markdown.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # @Author  : llc
 # @Time    : 2021/8/11 10:39
-from flask_openapi3.models import OPENAPI3_REF_PREFIX
+from .models import OPENAPI3_REF_PREFIX
 
 
 def parse_schemas(schemas):

flask_openapi3/openapi.py

@@ -13,6 +13,7 @@
 from pydantic import BaseModel
 
 from .api_blueprint import APIBlueprint
+from .commands import openapi_command
 from .do_wrapper import _do_wrapper
 from .http import HTTPMethod
 from .markdown import openapi_to_markdown
@@ -98,6 +99,8 @@ def __init__(
         self.doc_expansion = doc_expansion
         self.severs = servers
         self.external_docs = external_docs
+        # add openapi command
+        self.cli.add_command(openapi_command)
 
     def init_doc(self) -> None:
         """

setup.py

@@ -29,6 +29,7 @@
     zip_safe=False,
     platforms='any',
     install_requires=["Flask>=2.0", "pydantic>=1.2"],
+    extras_require={'yaml': ['pyyaml']},
     classifiers=[
         # 'Development Status :: 1 - Planning',
         # 'Development Status :: 2 - Pre-Alpha',