1.在superset中,要添加新的API,需要在superset/views/api.py文件中定义视图和API路由。例如:
from flask_appbuilder.api import expose
from flask_appbuilder.views import BaseView
from flask import jsonify
class MyCustomApi(BaseView):
route_base = '/myapi'
@expose('/get_data/')
def get_data(self):
data = {'key': 'value'}
return jsonify(data)
appbuilder.add_view_no_menu(MyCustomApi)
2.在定义API路由时,需要使用@expose
修饰符注释,以指定API的URL路径和HTTP方法。在上面的示例中,定义了一个名为myapi
的API路径,其中包含get_data
这个GET方法。
3.添加完新的API后,需要重新启动superset服务器,以使更改生效。
4.如果在使用新的API时遇到拒绝访问的错误消息,可能是由于缺少适当的权限配置导致的。可以通过在superset_config.py文件中添加以下内容来解决此问题:
from flask_appbuilder.security.decorators import has_access_api
from superset.views.api import SupersetApiView
class CustomSupersetApiSecurityMixin(object):
@staticmethod
def wrap_api_method(func):
@wraps(func)
@has_access_api
def wrapper(*args, **kwargs):
return func(*args, **kwargs)
return wrapper
class MyCustomApi(SupersetApiView, CustomSupersetApiSecurityMixin):
route_base = '/myapi'
@expose('/get_data/')
@CustomSupersetApiSecurityMixin.wrap_api_method
def get_data(self):
data = {'key': 'value'}
return jsonify(data)
appbuilder.add_view_no_menu(MyCustomApi)
上述代码定义了一个名为CustomSupersetApiSecurityMixin
的类,该类将has_access_api
修饰符用于API方法。然后,使用自定义的MyCustomApi
类继承自SupersetApiView
和CustomSupersetApiSecurityMixin
,以确保适当的权限配置。
5.最后,如果仍然无法访问新的API,请检查是否已授予适当的角色/组访问API的权限。可以通过superset web界面中的Security->Roles/Permission菜单进行配置。