GUIコンポーネントとAPIコンポーネントの両方を持つFlaskアプリケーションをセットアップしたいと思います。だからここのグループのリストを取得する簡単な例です:FlaskでHTMLとJSONの両方のコンテンツを提供するにはどうすればよいですか?
def get_groups():
groups = db.session.query(SgmGroup.group_name).order_by(SgmGroup.group_name).all()
return [group.group_name for group in groups]
@app.route('/list')
def group_list():
groups_list = get_groups()
return render_template('groups.html', groups=groups_list)
は、これまでのところは良い - これはおそらく、テーブルまたは他のいくつかの素敵なGUI形式で、ユーザーにユーザーのHTMLのリストが表示されます。
しかし、私はまた、APIリクエストに対するJSONコンテンツを提供したいと思います:
@app.route('/api/list')
def api_group_list():
groups_list = get_groups()
return jsonify({'groups': group_list})
これは動作します - しかし、これは良いアイデアですか?私は2つの質問があります:
1)これは2つの異なるタイプのコンテンツを持っているときにFlaskを使うのに適した方法ですか?ウェブブラウザ用のURLは/endpoint
(HTML)、APIリクエスト(JSON)を処理するURLは/api/endpoint
と同じですか?
2)または、これらの2つのエンドポイントを1つの関数に結合する必要がありますか?それはうまくいくように見えますが、ユーザーがどのエンドポイントにアクセスしたかはどのように判断できますか?つまり、以下の擬似コードを実行できますか?
@app.route('/list')
@app.route('/api/list')
def group_list():
groups_list = get_groups()
if <user arrived here via the /list endpoint>:
return render_template('groups.html', groups=groups_list)
elif <user arrived here via the /api/list endpoint>:
return jsonify({'groups': group_list})
も '?フォーマット= json'のようなもののために、テストをクエリのparamを使用していない場合は、それが存在するか、テンプレートの場合はJSONを返すことができます。個人的には、私はapiルートとhtmlルートのための別々の青写真を保っています。 – reptilicus
私は以前に青写真を調べていませんでした(私は、彼らが私のイントロレベルのスキルを超えて進歩したFlaskのものだと考えましたが)。 –