如何正确记录python烧瓶路线

Question

我试图记录这个函数并且想知道我应该在文档字符串中包含什么样的东西。我正在使用 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)

Answer 1

我建议你使用apispec，它支持 OpenAPI 规范。还有一个 Flask 插件，可以为你生成 YAML。