[DEV] update to sonic with a generic swagger

This commit is contained in:
Edouard DUPIN 2019-11-26 23:44:51 +01:00
parent 54db5f4a7f
commit b6a27fe99a
3 changed files with 351 additions and 151 deletions

View File

@ -2,9 +2,9 @@ FROM python:alpine
RUN pip install --upgrade pip RUN pip install --upgrade pip
RUN pip install flask RUN pip install sanic
RUN pip install flask_restful RUN pip install sanic-simple-swagger
RUN pip install python-dateutil RUN pip install python-dateutil

View File

@ -11,8 +11,14 @@
#pip install flask_restful --user #pip install flask_restful --user
#pip install python-dateutil --user #pip install python-dateutil --user
from flask import Flask from sanic import Sanic
from flask_restful import Api, Resource, reqparse from sanic import response
from sanic import views
from sanic import Blueprint
from sanic.exceptions import ServerError
from sanic_simple_swagger import swagger_blueprint, openapi_blueprint
from sanic_simple_swagger import doc
import dateutil.parser import dateutil.parser
@ -29,12 +35,25 @@ import data_interface
import data_global_elements import data_global_elements
debug.info("connect BDD interface"); app = Sanic("REST_video")
app.config['API_VERSION'] = '1.0.0'
app.config['API_TITLE'] = 'Rest personal video API'
app.config['API_DESCRIPTION'] = 'Simple API for the Video broker.'
app.config['API_CONTACT_EMAIL'] = "yui.heero@gmail.com"
app.config['API_LICENSE_NAME'] = 'MPL 2.0'
app.config['API_LICENSE_URL'] = 'https://www.mozilla.org/en-US/MPL/2.0/'
app.config['schemes'] = ['http', 'https']
app.blueprint(openapi_blueprint)
app.blueprint(swagger_blueprint)
@app.route("/")
@doc.description("Get all the Theme elements")
async def test(request):
return response.json({"hello": "world"})
app = Flask(__name__)
api = Api(app)
def add_interface(_name): def add_interface(_name):
data_global_elements.add_interface(_name, data_interface.DataInterface(_name, os.path.join(tools.get_run_path(), "data", "bdd_" + _name + ".json"))) data_global_elements.add_interface(_name, data_interface.DataInterface(_name, os.path.join(tools.get_run_path(), "data", "bdd_" + _name + ".json")))
@ -48,6 +67,318 @@ add_interface(API_SAISON)
API_VIDEO = "video" API_VIDEO = "video"
add_interface(API_VIDEO) add_interface(API_VIDEO)
"""
class ThemeListView(views.HTTPMethodView):
def __init__(self):
self.name = API_THEME
@doc.description("Get all the Theme elements")
async def get(self, request):
return response.json(data_global_elements.get_interface(self.name).gets())
async def post(self, request):
return response.json(data_global_elements.get_interface(self.name).post(request.json))
class ThemeView(views.HTTPMethodView):
def __init__(self):
self.name = API_THEME
async def get(self, request, id):
value = data_global_elements.get_interface(self.name).get(id)
if value != None:
return response.json(value)
raise ServerError("No data found", status_code=404)
async def put(self, request, id):
ret = data_global_elements.get_interface(self.name).put(id)
return response.json({})
" ""
async def patch(self, request, id):
return response.text('I am patch method')
"" "
async def delete(self, request, id):
return response.text('I am delete method')
ret = data_global_elements.get_interface(self.name).delete(id)
if ret == True:
return response.json({})
raise ServerError("No data found", status_code=404)
theme_blueprint = Blueprint(API_THEME)
theme_blueprint.add_route(ThemeListView.as_view(), '/' + API_THEME + '/', strict_slashes=True)
theme_blueprint.add_route(ThemeView.as_view(), '/' + API_THEME + '/<id:int>', strict_slashes=True)
app.blueprint(theme_blueprint)
"""
def add_theme(_app, _name_api):
elem_blueprint = Blueprint(_name_api)
class DataModel:
name = str
description = str
@elem_blueprint.get('/' + _name_api, strict_slashes=True)
@doc.summary("Show resources")
@doc.description("Display a listing of the resource.")
@doc.produces(content_type='application/json')
async def list(request):
return response.json(data_global_elements.get_interface(_name_api).gets())
@elem_blueprint.post('/' + _name_api, strict_slashes=True)
@doc.summary("Create new resource")
@doc.description("Store a newly created resource in storage.")
@doc.consumes(DataModel, location='body')#, required=True)
@doc.response_success(status=201, description='If successful created')
async def create(request):
return response.json(data_global_elements.get_interface(_name_api).post(request.json))
@elem_blueprint.get('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Show resources")
@doc.description("Display a listing of the resource.")
@doc.produces(content_type='application/json')
async def retrive(request, id):
value = data_global_elements.get_interface(_name_api).get(id)
if value != None:
return response.json(value)
raise ServerError("No data found", status_code=404)
@elem_blueprint.put('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Update resource")
@doc.description("Update the specified resource in storage.")
@doc.response_success(status=201, description='If successful updated')
async def update(request, id):
ret = data_global_elements.get_interface(_name_api).put(id)
return response.json({})
@elem_blueprint.delete('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Remove resource")
@doc.description("Remove the specified resource from storage.")
@doc.response_success(status=201, description='If successful deleted')
async def delete(request, id):
ret = data_global_elements.get_interface(_name_api).delete(id)
if ret == True:
return response.json({})
raise ServerError("No data found", status_code=404)
_app.blueprint(elem_blueprint)
add_theme(app, API_THEME)
def add_group(_app, _name_api):
elem_blueprint = Blueprint(_name_api)
class DataModel:
name = str
@elem_blueprint.get('/' + _name_api, strict_slashes=True)
@doc.summary("Show resources")
@doc.description("Display a listing of the resource.")
@doc.produces(content_type='application/json')
async def list(request):
return response.json(data_global_elements.get_interface(_name_api).gets())
@elem_blueprint.post('/' + _name_api, strict_slashes=True)
@doc.summary("Create new resource")
@doc.description("Store a newly created resource in storage.")
@doc.consumes(DataModel, location='body')#, required=True)
@doc.response_success(status=201, description='If successful created')
async def create(request):
return response.json(data_global_elements.get_interface(_name_api).post(request.json))
@elem_blueprint.get('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Show resources")
@doc.description("Display a listing of the resource.")
@doc.produces(content_type='application/json')
async def retrive(request, id):
value = data_global_elements.get_interface(_name_api).get(id)
if value != None:
return response.json(value)
raise ServerError("No data found", status_code=404)
@elem_blueprint.put('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Update resource")
@doc.description("Update the specified resource in storage.")
@doc.response_success(status=201, description='If successful updated')
async def update(request, id):
ret = data_global_elements.get_interface(_name_api).put(id)
return response.json({})
@elem_blueprint.delete('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Remove resource")
@doc.description("Remove the specified resource from storage.")
@doc.response_success(status=201, description='If successful deleted')
async def delete(request, id):
ret = data_global_elements.get_interface(_name_api).delete(id)
if ret == True:
return response.json({})
raise ServerError("No data found", status_code=404)
_app.blueprint(elem_blueprint)
add_group(app, API_GROUP)
def add_saison(_app, _name_api):
elem_blueprint = Blueprint(_name_api)
class DataModel:
number = int
group_id = int
@elem_blueprint.get('/' + _name_api, strict_slashes=True)
@doc.summary("Show saisons")
@doc.description("Display a listing of the resource.")
@doc.produces(content_type='application/json')
async def list(request):
return response.json(data_global_elements.get_interface(_name_api).gets())
@elem_blueprint.post('/' + _name_api, strict_slashes=True)
@doc.summary("Create new saison")
@doc.description("Create a new saison for a aspecific group id.")
@doc.consumes(DataModel, location='body')#, required=True)
@doc.response_success(status=201, description='If successful created')
async def create(request):
return response.json(data_global_elements.get_interface(_name_api).post(request.json))
@elem_blueprint.get('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Show resources")
@doc.description("Display a listing of the resource.")
@doc.produces(content_type='application/json')
async def retrive(request, id):
value = data_global_elements.get_interface(_name_api).get(id)
if value != None:
return response.json(value)
raise ServerError("No data found", status_code=404)
@elem_blueprint.put('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Update resource")
@doc.description("Update the specified resource in storage.")
@doc.response_success(status=201, description='If successful updated')
async def update(request, id):
ret = data_global_elements.get_interface(_name_api).put(id)
return response.json({})
@elem_blueprint.delete('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Remove resource")
@doc.description("Remove the specified resource from storage.")
@doc.response_success(status=201, description='If successful deleted')
async def delete(request, id):
ret = data_global_elements.get_interface(_name_api).delete(id)
if ret == True:
return response.json({})
raise ServerError("No data found", status_code=404)
_app.blueprint(elem_blueprint)
add_saison(app, API_SAISON)
def add_video(_app, _name_api):
elem_blueprint = Blueprint(_name_api)
class DataModel:
saison_id = int
group_id = int
name = str
description = str
# creating time
date = str
# number of second
time = int
@elem_blueprint.get('/' + _name_api, strict_slashes=True)
@doc.summary("Show saisons")
@doc.description("Display a listing of the resource.")
@doc.produces(content_type='application/json')
async def list(request):
return response.json(data_global_elements.get_interface(_name_api).gets())
@elem_blueprint.post('/' + _name_api, strict_slashes=True)
@doc.summary("Create new saison")
@doc.description("Create a new saison for a aspecific group id.")
@doc.consumes(DataModel, location='body')#, required=True)
@doc.response_success(status=201, description='If successful created')
async def create(request):
return response.json(data_global_elements.get_interface(_name_api).post(request.json))
@elem_blueprint.get('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Show resources")
@doc.description("Display a listing of the resource.")
@doc.produces(content_type='application/json')
async def retrive(request, id):
value = data_global_elements.get_interface(_name_api).get(id)
if value != None:
return response.json(value)
raise ServerError("No data found", status_code=404)
@elem_blueprint.put('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Update resource")
@doc.description("Update the specified resource in storage.")
@doc.response_success(status=201, description='If successful updated')
async def update(request, id):
ret = data_global_elements.get_interface(_name_api).put(id)
return response.json({})
@elem_blueprint.delete('/' + _name_api + '/<id:int>', strict_slashes=True)
@doc.summary("Remove resource")
@doc.description("Remove the specified resource from storage.")
@doc.response_success(status=201, description='If successful deleted')
async def delete(request, id):
ret = data_global_elements.get_interface(_name_api).delete(id)
if ret == True:
return response.json({})
raise ServerError("No data found", status_code=404)
_app.blueprint(elem_blueprint)
add_video(app, API_VIDEO)
"""
def add_group(_group_name):
@app.route("/qsdqd")
@doc.description("Get all the Theme " + _group_name)
@doc.consumes({'name': str}, location='query', description='Student name', example={'name': 'john'})
async def test(request):
return response.json({"hello": "world"})
add_group("sqdfqsdfqsfgqsdf")
"""
def add_student(_app):
student_blueprint = Blueprint("student")
class Student:
name = str
address = str
@student_blueprint.get('/student', strict_slashes=True)
@doc.summary("Show resources")
@doc.description("Display a listing of the resource.")
@doc.deprecated(True) #if the api is deprecated
@doc.produces(content_type='application/json')
@doc.consumes({'name': str}, location='query', description='Student name', example={'name': 'john'})
async def index(request):
pass
@student_blueprint.post('/student', strict_slashes=True)
@doc.summary("Create new resource")
@doc.description("Store a newly created resource in storage.")
@doc.consumes(Student, location='body', required=True)
@doc.response_success(status=201, description='If successful created')
async def store(request):
pass
@student_blueprint.put('/student/<id:int>', strict_slashes=True)
@doc.summary("Update resource")
@doc.description("Update the specified resource in storage.")
@doc.response_success(status=201, description='If successful updated')
async def update(request, id):
pass
@student_blueprint.delete('/student/<id:int>', strict_slashes=True)
@doc.summary("Remove resource")
@doc.description("Remove the specified resource from storage.")
@doc.response_success(status=201, description='If successful deleted')
async def delete(request, id):
pass
_app.blueprint(student_blueprint)
add_student(app)
""" """
LIST_themes = [ LIST_themes = [
{ {
@ -94,7 +425,7 @@ class Theme(Resource):
return elem, 200 return elem, 200
return "No data found in list of element: " + str(len(LIST_themes)), 404 return "No data found in list of element: " + str(len(LIST_themes)), 404
""" """
"""
class ThemeList(Resource): class ThemeList(Resource):
def __init__(self): def __init__(self):
self.name = API_THEME self.name = API_THEME
@ -103,14 +434,14 @@ class ThemeList(Resource):
def get(self): def get(self):
return data_global_elements.get_interface(self.name).gets(), 200 return data_global_elements.get_interface(self.name).gets(), 200
""" " ""
def post(self): def post(self):
args = parser.parse_args() args = parser.parse_args()
todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1 todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1
todo_id = 'todo%i' % todo_id todo_id = 'todo%i' % todo_id
TODOS[todo_id] = {'task': args['task']} TODOS[todo_id] = {'task': args['task']}
return TODOS[todo_id], 201 return TODOS[todo_id], 201
""" "" "
class Theme(Resource): class Theme(Resource):
def __init__(self): def __init__(self):
@ -128,153 +459,22 @@ class Theme(Resource):
if ret == True: if ret == True:
return '', 204 return '', 204
return "No data found", 404 return "No data found", 404
""" "" "
def put(self, id): def put(self, id):
ret = data_global_elements.get_interface(self.name).put(id) ret = data_global_elements.get_interface(self.name).put(id)
return task, 201 return task, 201
""" " ""
api.add_resource(ThemeList, "/api/v1/" + API_THEME) api.add_resource(ThemeList, "/api/v1/" + API_THEME)
api.add_resource(Theme, "/api/v1/" + API_THEME + "/<int:id>") api.add_resource(Theme, "/api/v1/" + API_THEME + "/<int:id>")
"""
#---------------------------------------------------------------------------------------
class GroupList(Resource):
def __init__(self): if __name__ == "__main__":
self.name = API_GROUP rest_config = config.get_rest_config()
debug.info("Start REST application: " + str(rest_config["host"]) + ":" + str(rest_config["port"]))
app.run(host=rest_config["host"], port=int(rest_config["port"]))
debug.info("END program");
# example use: curl http://127.0.0.1:15080/api/v1/Group
def get(self):
return data_global_elements.get_interface(self.name).gets(), 200
"""
def post(self):
args = parser.parse_args()
todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1
todo_id = 'todo%i' % todo_id
TODOS[todo_id] = {'task': args['task']}
return TODOS[todo_id], 201
"""
class Group(Resource):
def __init__(self):
self.name = API_GROUP
# example use: curl http://127.0.0.1:15080/api/v1/Group/xxx
def get(self, id):
value = data_global_elements.get_interface(self.name).get(id)
if value != None:
return value, 200
return "No data found", 404
def delete(self, id):
ret = data_global_elements.get_interface(self.name).delete(id)
if ret == True:
return '', 204
return "No data found", 404
"""
def put(self, id):
ret = data_global_elements.get_interface(self.name).put(id)
return task, 201
"""
api.add_resource(GroupList, "/api/v1/" + API_GROUP)
api.add_resource(Group, "/api/v1/" + API_GROUP + "/<int:id>")
#---------------------------------------------------------------------------------------
class SaisonList(Resource):
def __init__(self):
self.name = API_SAISON
# example use: curl http://127.0.0.1:15080/api/v1/Saison
def get(self):
return data_global_elements.get_interface(self.name).gets(), 200
"""
def post(self):
args = parser.parse_args()
todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1
todo_id = 'todo%i' % todo_id
TODOS[todo_id] = {'task': args['task']}
return TODOS[todo_id], 201
"""
class Saison(Resource):
def __init__(self):
self.name = API_SAISON
# example use: curl http://127.0.0.1:15080/api/v1/Saison/xxx
def get(self, id):
value = data_global_elements.get_interface(self.name).get(id)
if value != None:
return value, 200
return "No data found", 404
def delete(self, id):
ret = data_global_elements.get_interface(self.name).delete(id)
if ret == True:
return '', 204
return "No data found", 404
"""
def put(self, id):
ret = data_global_elements.get_interface(self.name).put(id)
return task, 201
"""
api.add_resource(SaisonList, "/api/v1/" + API_SAISON)
api.add_resource(Saison, "/api/v1/" + API_SAISON + "/<int:id>")
#---------------------------------------------------------------------------------------
class VideoList(Resource):
def __init__(self):
self.name = API_VIDEO
# example use: curl http://127.0.0.1:15080/api/v1/Video
def get(self):
return data_global_elements.get_interface(self.name).gets(), 200
"""
def post(self):
args = parser.parse_args()
todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1
todo_id = 'todo%i' % todo_id
TODOS[todo_id] = {'task': args['task']}
return TODOS[todo_id], 201
"""
class Video(Resource):
def __init__(self):
self.name = API_VIDEO
# example use: curl http://127.0.0.1:15080/api/v1/Video/xxx
def get(self, id):
value = data_global_elements.get_interface(self.name).get(id)
if value != None:
return value, 200
return "No data found", 404
def delete(self, id):
ret = data_global_elements.get_interface(self.name).delete(id)
if ret == True:
return '', 204
return "No data found", 404
"""
def put(self, id):
ret = data_global_elements.get_interface(self.name).put(id)
return task, 201
"""
api.add_resource(VideoList, "/api/v1/" + API_VIDEO)
api.add_resource(Video, "/api/v1/" + API_VIDEO + "/<int:id>")
rest_config = config.get_rest_config()
debug.info("Start REST application: " + str(rest_config["host"]) + ":" + str(rest_config["port"]))
app.run(debug=False, host=rest_config["host"], port=str(rest_config["port"]))
debug.info("END program");
sys.exit(0)