support header

Author: mohsenasm

app/app.py

@@ -5,6 +5,8 @@
 from resources import HelloWorld, Car
 from models import db
 
+from resources import CarByName
+
 
 def create_app():
     app = Flask(__name__)
@@ -26,14 +28,16 @@ def create_app():
     api = Api(app)
     api.add_resource(HelloWorld, '/')
     api.add_resource(Car, '/car')
+    api.add_resource(CarByName, '/car_by_name')
 
     # Spec (/swagger & /swagger-ui)
     docs = FlaskApiSpec(app)
     docs.register(Car)
+    docs.register(CarByName)
 
     return app
 
 
 if __name__ == '__main__':
     app = create_app()
-    app.run(port=7654, host='0.0.0.0')
+    app.run(port=7654, host='0.0.0.0', debug=True)

app/resources.py

@@ -1,5 +1,5 @@
-from flask_restful import Resource
-from flask_apispec import MethodResource, marshal_with, use_kwargs
+from flask_restful import Resource, request
+from flask_apispec import MethodResource, marshal_with, use_kwargs, doc
 import marshmallow as ma
 
 from models import db, CarsModel
@@ -39,3 +39,10 @@ def post(self, **kwargs):
         db.session.commit()
         return {"message": f"car {new_car.name} has been created successfully."}
 
+
+class CarByName(MethodResource, Resource):
+    @doc(params={'pet_id': {'description': 'pet id', 'in': 'header'}})
+    @use_kwargs(CarSchema, location='query')  # input CarSchema
+    def get(self, **kwargs):
+        return request.headers["pet_id"]
+

doc_decorator_example.png

@@ -4,6 +4,8 @@ services:
     app:
         build: './app'
         restart: always
+        volumes:
+            - ./app:/app
         ports:
             - 7654:7654