Мне интересно, как разработчики бэкэнда / внешнего интерфейса могут работать вместе для приложения Flask + jinja2.
Если бэкэнд предоставляется только через API-интерфейсы GraphQL / REST, то у вас есть определение схемы / Swagger.
Для чего нужна колба + jinja2 для генерации документации?
Пример
from flask import Flask, render_template
app = Flask(__name__)
@app.route("/some-route")
def index():
"""Help the user to achieve foobar."""
return render_template('template-file.html',
foo='bar')
Вещи, которые нуждаются в документации:
- Какие файлы шаблонов ожидаются где (
'template-file.html'), возможно, путем создания заглушки? - Контекст, о чем это представление (например, с использованием строки документа?)
- Доступные переменные (
foo) и их тип / потенциальные значения
Или это не работает, и разработчики внешнего интерфейса должны проверять маршруты?