add swageer to UserResource

Author: Ask-coder

api/__init__.py

@@ -8,19 +8,43 @@
 from flask_httpauth import HTTPBasicAuth
 from flask_httpauth import HTTPTokenAuth
 from flask_httpauth import MultiAuth
+from flasgger import Swagger
+from apispec import APISpec
+from apispec.ext.marshmallow import MarshmallowPlugin
+from flask_apispec.extension import FlaskApiSpec
 
 
 app = Flask(__name__)
 app.config.from_object(Config)
 
+security_definitions = {
+    "basicAuth": {
+        "type": "basic"
+    }
+}
+app.config.update({
+   'APISPEC_SPEC': APISpec(
+       title='Notes Project',
+       version='v1',
+       plugins=[MarshmallowPlugin()],
+       securityDefinitions=security_definitions,
+       securitu=[],
+       openapi_version='2.0.0'
+   ),
+   'APISPEC_SWAGGER_URL': '/swagger', # URI API Doc JSON
+   'APISPEC_SWAGGER_UI_URL': '/swagger-ui'# URI UI of API Doc
+})
+
+
 api = Api(app)
 db = SQLAlchemy(app)
 migrate = Migrate(app, db)
 ma = Marshmallow(app)
 basic_auth = HTTPBasicAuth()
 token_auth = HTTPTokenAuth('Bearer')
 auth = MultiAuth(basic_auth, token_auth)
-
+swagger = Swagger(app)
+docs = FlaskApiSpec(app)
 
 @token_auth.verify_token
 def verify_token(token):

api/resources/user.py

@@ -1,17 +1,55 @@
 from api import Resource, abort, reqparse, auth, db
 from api.models.user import UserModel
-from api.schemas.user import user_schema, users_schema
+from api.schemas.user import user_schema,  users_schema
+from api.schemas.user import UserSchema, UserRequestSchema
+from flask_apispec.views import MethodResource
+from flask_apispec import marshal_with, use_kwargs, doc
 
 
-class UserResource(Resource):
+@doc(description='Api for notes.', tags=['Users'])
+class UserResource(MethodResource):
+    @marshal_with(UserSchema, code=200)
     def get(self, user_id):
+        # language=YAML
+        """
+        Get User by id
+        ---
+        tags:
+            - User
+        """
         user = UserModel.query.get(user_id)
         if user is None:
             abort(404, error=f"User with id={user_id} not found")
         return user_schema.dump(user), 200
 
     @auth.login_required(role="admin")
     def put(self, user_id):
+        # language = YAML
+        """
+        Get User by id
+        ---
+        tags:
+            - Users
+        parameters:
+            - in: path
+              name: user_id
+              type: integer
+              required: true
+              default: 1
+        responses:
+            200:
+                description: A single user item
+                schema:
+                id: User
+                properties:
+                id:
+                    type: integer
+                username:
+                    type: string
+                is_staff:
+                    type: boolean
+
+        """
         parser = reqparse.RequestParser()
         parser.add_argument("username", required=True)
         user_data = parser.parse_args()
@@ -31,17 +69,19 @@ def delete(self, user_id):
         return "", 204
 
 
-class UsersListResource(Resource):
+class UsersListResource(MethodResource):
+    @marshal_with(UserSchema(many=True), code=200)
     def get(self):
         users = UserModel.query.all()
         return users_schema.dump(users), 200
 
-    def post(self):
-        parser = reqparse.RequestParser()
-        parser.add_argument("username", required=True)
-        parser.add_argument("password", required=True)
-        user_data = parser.parse_args()
-        user = UserModel(**user_data)
+    @use_kwargs(UserRequestSchema, location='json')
+    def post(self, **kwargs):
+        # parser = reqparse.RequestParser()
+        # parser.add_argument("username", required=True)
+        # parser.add_argument("password", required=True)
+        # user_data = parser.parse_args()
+        user = UserModel(**kwargs)
         user.save()
         if not user.id:
             abort(400, error=f"User with username:{user.username} already exist")

api/schemas/user.py

@@ -13,5 +13,13 @@ class Meta:
         fields = ('id', 'username', "is_staff")
 
 
+class UserRequestSchema(ma.SQLAlchemySchema):
+    class Meta:
+        model = UserModel
+
+    username = ma.Str()
+    password = ma.Str()
+
+
 user_schema = UserSchema()
 users_schema = UserSchema(many=True)

app.py

@@ -1,9 +1,11 @@
-from api import api, app
+from api import api, app, docs
 from api.resources.note import NoteResource, NotesListResource
 from api.resources.user import UserResource, UsersListResource
 from api.resources.auth import TokenResource
 from config import Config
 
+
+
 # CRUD
 
 # Create --> POST
@@ -24,6 +26,8 @@
 api.add_resource(NoteResource,
                  '/notes/<int:note_id>',  # GET, PUT, DELETE
                  )
+docs.register(UserResource)
+docs.register(UsersListResource)
 
 if __name__ == '__main__':
     app.run(debug=Config.DEBUG, port=Config.PORT)

requirements.txt

@@ -1,11 +1,15 @@
 alembic==1.8.1
 aniso8601==9.0.1
+apispec==5.2.2
 asttokens==2.0.8
+attrs==22.1.0
 backcall==0.2.0
 click==8.1.3
 decorator==5.1.1
 executing==1.0.0
+flasgger==0.9.5
 Flask==2.2.2
+flask-apispec==0.11.4
 Flask-HTTPAuth==4.7.0
 flask-marshmallow==0.14.0
 Flask-Migrate==3.1.0
@@ -14,31 +18,41 @@ Flask-SQLAlchemy==2.5.1
 greenlet==1.1.3
 gunicorn==20.1.0
 importlib-metadata==4.12.0
+iniconfig==1.1.1
 ipython==8.1.0
 itsdangerous==2.1.2
 jedi==0.18.1
 Jinja2==3.1.2
+jsonschema==4.16.0
 Mako==1.2.2
 MarkupSafe==2.1.1
 marshmallow==3.18.0
 marshmallow-sqlalchemy==0.24.2
 matplotlib-inline==0.1.6
+mistune==2.0.4
 packaging==21.3
 parso==0.8.3
 passlib==1.7.4
 pexpect==4.8.0
 pickleshare==0.7.5
+pluggy==1.0.0
 prompt-toolkit==3.0.31
 psycopg2-binary==2.9.3
 ptyprocess==0.7.0
 pure-eval==0.2.2
+py==1.11.0
 Pygments==2.13.0
 pyparsing==3.0.9
+pyrsistent==0.18.1
+pytest==7.1.3
 pytz==2022.2.1
+PyYAML==6.0
 six==1.16.0
 SQLAlchemy==1.4.41
 stack-data==0.5.0
+tomli==2.0.1
 traitlets==5.4.0
 wcwidth==0.2.5
+webargs==8.2.0
 Werkzeug==2.2.2
 zipp==3.8.1