📡 You're offline — showing cached content
⚡ New version available!
Quick Access
🗺️ Roadmaps 🃏 Flashcards 📚 Series 🎓 Tutorials 🗺️ My Path 🎤 Mock Interview ⚡ Cheat Code 📄 Resume Builder 🛠️ Dev Tools
Tutorials › Flask Web Framework › Flask Swagger Docs

Flask Swagger Docs

5 min read
Document Flask APIs with Swagger UI using Flask-RESTX model definitions and route decorators.

API Documentation

pip install flask-restx

from flask_restx import Api, Resource, fields

api = Api(app, title="My API", version="1.0", doc="/docs")

user_model = api.model("User", {
    "id":   fields.Integer(readonly=True),
    "name": fields.String(required=True),
})

@api.route("/users")
class UserList(Resource):
    @api.marshal_list_with(user_model)
    def get(self): return User.query.all()