Elenca tutti i percorsi disponibili in Flask, insieme alle corrispondenti funzioni "docstrings

Question

Sto scrivendo una piccola API e volevo stampare un elenco di tutti i metodi disponibili insieme al corrispondente" testo di aiuto "(dalla docstring della funzione). Partendo da this answer, ho scritto il seguente:

from flask import Flask, jsonify 

app = Flask(__name__) 

@app.route('/api', methods = ['GET']) 
def this_func(): 
    """This is a function. It does nothing.""" 
    return jsonify({ 'result': '' }) 

@app.route('/api/help', methods = ['GET']) 
    """Print available functions.""" 
    func_list = {} 
    for rule in app.url_map.iter_rule(): 
     if rule.endpoint != 'static': 
      func_list[rule.rule] = eval(rule.endpoint).__doc__ 
    return jsonify(func_list) 

if __name__ == '__main__': 
    app.run(debug=True) 

c'è un meglio-più sicuro - modo di fare questo? Grazie.

Answer 1

C'è app.view_functions. Penso che sia esattamente quello che vuoi.

from flask import Flask, jsonify 

app = Flask(__name__) 

@app.route('/api', methods = ['GET']) 
def this_func(): 
    """This is a function. It does nothing.""" 
    return jsonify({ 'result': '' }) 

@app.route('/api/help', methods = ['GET']) 
def help(): 
    """Print available functions.""" 
    func_list = {} 
    for rule in app.url_map.iter_rules(): 
     if rule.endpoint != 'static': 
      func_list[rule.rule] = app.view_functions[rule.endpoint].__doc__ 
    return jsonify(func_list) 

if __name__ == '__main__': 
    app.run(debug=True) 

Answer 2

from flask import Flask, jsonify 

app = Flask(__name__) 

@app.route('/api/help', methods=['GET']) 
def help(): 
    endpoints = [rule.rule for rule in app.url_map.iter_rules() 
       if rule.endpoint !='static'] 
    return jsonify(dict(api_endpoints=endpoints)) 

if __name__ == '__main__': 
     app.run(debug=True)