def docs(schema):
codec = codecs.OpenAPICodec()
content = schema.read()
document = codec.decode(content)
loader = jinja2.PrefixLoader({
'apistar': jinja2.PackageLoader('apistar', 'templates')
})
env = jinja2.Environment(autoescape=True, loader=loader)
template = env.get_template('apistar/docs/index.html')
code_style = None # pygments_css('emacs')
output_text = template.render(
document=document,
langs=['javascript', 'python'],
code_style=code_style,
static_url=static_url
)
directory = 'site'
output_path = os.path.join(directory, 'index.html')
if not os.path.exists(directory):
os.makedirs(directory)
output_file = open(output_path, 'w')
output_file.write(output_text)
output_file.close()
static_dir = os.path.join(os.path.dirname(apistar.__file__), 'static')
shutil.copytree(static_dir, os.path.join(directory, 'apistar'))
click.echo('Documentation built at %s' % output_path)
def validate(schema):
codec = codecs.OpenAPICodec()
content = schema.read()
if content.decode().strip() and content.decode().strip()[0] in '{[':
content_type = 'json'
else:
content_type = 'yaml'
try:
codec.decode(content)
except (ParseError, ValidationError) as exc:
errors = get_errors(content, exc, content_type)
lines = content.splitlines()
for error in reversed(errors):
error_str = ' ' * (error.start.column - 1)
error_str += '^ '
error_str += error.message
error_str = click.style(error_str, fg='red')
lines.insert(error.start.row, error_str)
for line in lines:
click.echo(line)
click.echo()
if isinstance(exc, ParseError) and content_type == 'json':
click.echo(click.style('✘', fg='red') + ' Invalid JSON.')
elif isinstance(exc, ParseError) and content_type == 'yaml':
click.echo(click.style('✘', fg='red') + ' Invalid YAML.')
else:
click.echo(click.style('✘', fg='red') + ' Invalid OpenAPI 3 document.')
else:
click.echo(click.style('✓', fg='green') + ' Valid OpenAPI 3 document.')
def validate(schema):
codec = codecs.OpenAPICodec()
content = schema.read()
try:
codec.decode(content)
except (ParseError, ValidationError) as exc:
lines = content.splitlines()
for error in reversed(exc.get_errors()):
error_str = ' ' * (error.marker.column_number - 1)
error_str += '^ '
error_str += error.message
error_str = click.style(error_str, fg='red')
lines.insert(error.marker.line_number, error_str)
for line in lines:
click.echo(line)
click.echo()
if isinstance(exc, ParseError) and exc.base_format == 'json':
click.echo(click.style('✘', fg='red') + ' Invalid JSON.')
elif isinstance(exc, ParseError) and exc.base_format == 'yaml':
click.echo(click.style('✘', fg='red') + ' Invalid YAML.')
else:
click.echo(click.style('✘', fg='red') + ' Invalid OpenAPI 3 document.')
else:
click.echo(click.style('✓', fg='green') + ' Valid OpenAPI 3 document.')
def make_doc(directory):
app = App(routes=routes)
codec = codecs.OpenAPICodec()
content = codec.encode(app.document)
document = codec.decode(content)
loader = jinja2.PrefixLoader(
{"apistar": jinja2.PackageLoader("apistar", "templates")})
env = jinja2.Environment(autoescape=True, loader=loader)
template = env.get_template("apistar/docs/index.html")
code_style = None # pygments_css('emacs')
output_text = template.render(
document=document,
langs=["javascript", "python"],
code_style=code_style,
static_url=lambda x: x,
)
output_path = os.path.join(directory, "index.html")
if not os.path.exists(directory):
os.makedirs(directory)
output_file = open(output_path, "w")
output_file.write(output_text)
output_file.close()
static_dir = os.path.join(os.path.dirname(apistar.__file__), "static")
apistar_static_dir = os.path.join(directory, "apistar")
if os.path.exists(apistar_static_dir):
shutil.rmtree(apistar_static_dir)
shutil.copytree(static_dir, apistar_static_dir)
print(f"Documentation built at {output_path}")
def docs(schema):
codec = codecs.OpenAPICodec()
content = schema.read()
document = codec.decode(content)
loader = jinja2.PrefixLoader(
{"apistar": jinja2.PackageLoader("apistar", "templates")})
env = jinja2.Environment(autoescape=True, loader=loader)
template = env.get_template("apistar/docs/index.html")
code_style = None # pygments_css('emacs')
output_text = template.render(
document=document,
langs=["javascript", "python"],
code_style=code_style,
static_url=static_url,
)
directory = "site"
output_path = os.path.join(directory, "index.html")
if not os.path.exists(directory):
os.makedirs(directory)
output_file = open(output_path, "w")
output_file.write(output_text)
output_file.close()
static_dir = os.path.join(os.path.dirname(apistar.__file__), "static")
shutil.copytree(static_dir, os.path.join(directory, "apistar"))
click.echo("Documentation built at %s" % output_path)
def validate(schema):
codec = codecs.OpenAPICodec()
content = schema.read()
try:
codec.decode(content)
except (ParseError, ValidationError) as exc:
lines = content.splitlines()
for error in reversed(exc.get_errors()):
error_str = " " * (error.marker.column_number - 1)
error_str += "^ "
error_str += error.message
error_str = click.style(error_str, fg="red")
lines.insert(error.marker.line_number, error_str)
for line in lines:
click.echo(line)
click.echo()
if isinstance(exc, ParseError) and exc.base_format == "json":
click.echo(click.style("✘", fg="red") + " Invalid JSON.")
elif isinstance(exc, ParseError) and exc.base_format == "yaml":
click.echo(click.style("✘", fg="red") + " Invalid YAML.")
else:
click.echo(
click.style("✘", fg="red") + " Invalid OpenAPI 3 document.")
else:
click.echo(click.style("✓", fg="green") + " Valid OpenAPI 3 document.")