python - 如何正确记录python烧瓶路线
问题描述
我试图记录这个函数并且想知道我应该在文档字符串中包含什么样的东西。我正在使用 sphinx 作为文档生成器。
@app.route('/login', methods=['GET','POST'])
def login():
"""
This is the Login route endpoint.
Parameters:
GET:/login
POST:/login
Returns:
It renders the home.html template
"""
form = LoginForm()
if form.validate_on_submit():
user = User.query.filter_by(username=form.username.data).first()
if user:
if check_password_hash(user.password_hash, form.password.data):
login_user(user, remember=form.remember.data)
return redirect('/dashboard')
return '<h1> Invalid Username or Password!. Please try again.</h1>'
return render_template('login.html', form = form)
解决方案
我建议你使用apispec,它支持 OpenAPI 规范。还有一个 Flask 插件,可以为你生成 YAML。
推荐阅读
- cluster-analysis - 如何聚类向量组?
- c - 如何优化 a[i] = -b[i] * (c[i] + d);
- python - Where is from "ERROR: Spider error processing
I am reading a log from a previous spider's launching. I am curious to know where is from this exception and how I can act on it:
2019-04-12
- javascript - JavaScript Paper Scissors Stone - 需要指南
- python - 如何访问 Bloomberg API 调用的多索引格式中的数据
- java - SecureRandom.getInstanceStrong() 何时抛出 NoSuchAlgorithmException?
- php - 是否存在 AJAX 加载时间过长之类的问题?
- javascript - 试图从 javascript 中的组合框中进行选择,但通常的方式不起作用
- angular - 响应中的 Blob() 不显示原始图像 url,而是显示大小和类型
- qbasic - 计算单利并输出为表格形式