Add swagger

.gitignore

@@ -4,3 +4,4 @@ venv
 **/__pycache__
 .env
 *.sw?
+/.idea/

Mirador_backend/app.py

 from flask import Flask
 from flask_restful import Api
 from Mirador_backend.resources.mirador_resource import MiradorResource
+from flask_restful_swagger import swagger
+from apispec import APISpec
+from apispec.ext.marshmallow import MarshmallowPlugin
+from flask_apispec.extension import FlaskApiSpec
+
 
 app = Flask(__name__)
 api = Api(app)
+docs = FlaskApiSpec(app)
 
 api.add_resource(MiradorResource, '/mirador_resource', '/mirador_resource/<int:id>')
+docs.register(MiradorResource)
+
+
+app.config.update({
+    'APISPEC_SPEC': APISpec(
+        title='Mirador Backend',
+        version='v1',
+        plugins=[MarshmallowPlugin()],
+        openapi_version='2.0.0'
+    ),
+    'APISPEC_SWAGGER_URL': '/swagger/',  # URI to access API Doc JSON
+    'APISPEC_SWAGGER_UI_URL': '/swagger-ui/'  # URI to access UI of API Doc
+})
 
 if __name__ == '__main__':
     app.run(debug=True)

Mirador_backend/resources/mirador_resource.py

 from flask_restful import Resource
+from flask_restful_swagger import swagger
 
+from apispec import APISpec
+from marshmallow import Schema, fields
+from apispec.ext.marshmallow import MarshmallowPlugin
+from flask_apispec.extension import FlaskApiSpec
+from flask_apispec.views import MethodResource
+from flask_apispec import marshal_with, doc, use_kwargs
 
-class MiradorResource(Resource):
+class MRResponseSchema(Schema):
+	message = fields.Str(default='Success')
+
+
+class MRRequestSchema(Schema):
+	api_type = fields.String(required=True, description="API type of awesome API")
+
+
+class MiradorResource(MethodResource,Resource):
+	@doc(description='My First GET Awesome API.', tags=['Mirador resource'])
+	@marshal_with(MRResponseSchema)  # marshalling
 	def get(self, id=None):
 		return {'method': 'get', 'id': id}
 

setup.py

@@ -30,7 +30,7 @@ setup(
 
     packages=find_packages(),
 
-    install_requires=["flask", "flask-restful", "python-dotenv"],
+    install_requires=["flask", "flask-restful", "python-dotenv", "flask-restful-swagger", "flask-apispec"],
 
     setup_requires=[""],