Описание тега flask-restx

Flask-RESTX - это расширение для Flask, которое добавляет поддержку быстрого создания REST API в Python. Flask-RESTX - это форк Flask-RESTPlus, управляемый сообществом, поэтому пользователи также могут использовать тег [flask-restplus] в дополнение к [flask-restx] для поиска соответствующих проблем и вопросов.

Flask-RESTX - это расширение для Flask, которое добавляет поддержку для быстрого создания REST API.

Flask-RESTX поддерживает лучшие практики с минимальной настройкой. Если вы знакомы с Flask, Flask-RESTX должно быть легко освоить.

Он предоставляет согласованный набор декораторов и инструментов для описания вашего API и правильного предоставления документации с помощью Swagger.

Flask-RESTX - это форк Flask-RESTPlus, управляемый сообществом.


Минимальный API

Минимальный Flask-RESTX API выглядит так:

from flask import Flask
from flask_restx import Resource, Api

app = Flask(__name__)
api = Api(app)

@api.route('/hello')
class HelloWorld(Resource):
    def get(self):
        return {'hello': 'world'}

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

Совместимость

Flask-RESTX требует Python 2.7 или 3.4+.

Документация

Документация размещена на сайте Read the Docs.