1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
# -*- 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
@click.command(name="openapi")
@click.option("--output", "-o", type=click.Path(), help="The output file path.")
@click.option("--format", "-f", "_format", type=click.Choice(["json", "yaml"]), help="The output file format.")
@click.option("--indent", "-i", type=int, help="The indentation for JSON dumps.")
@with_appcontext
def openapi_command(output, _format, indent):
"""Export the OpenAPI Specification to console or a file"""
# Check if the current app has an api_doc attribute
if hasattr(current_app, "api_doc"):
obj = current_app.api_doc
# Generate the OpenAPI Specification based on the specified format
if _format == "yaml":
try:
import yaml # type: ignore
except ImportError: # pragma: no cover
raise ImportError("pyyaml must be installed.")
openapi = yaml.safe_dump(obj, allow_unicode=True)
else:
openapi = json.dumps(obj, indent=indent, ensure_ascii=False)
# Save the OpenAPI Specification to a file if the output path is provided
if output:
with open(output, "w", encoding="utf8") as f:
f.write(openapi)
click.echo(f"Saved to {output}.")
else:
click.echo(openapi)
|
