Issue Registering Custom API Endpoint in Apache Superset

[darshan200]

I'm facing an issue while trying to register a custom API endpoint in Apache Superset. Here's what I've done so far:

1. I added a new API class, ReportScheduleRestApi, in api.py. The class includes a @expose method for a /summary endpoint.
2. I registered the API in init.py using appbuilder.add_api(ReportScheduleRestApi).
3. Debugging logs show that the ReportScheduleRestApi class is being initialized and added to AppBuilder.
4. However, the /summary endpoint is not appearing in the Flask route list (flask routes), and I'm unable to access it via Postman or the browser. It results in a 404 error.

To troubleshoot:

1. I confirmed that other routes from ReportScheduleRestApi (e.g., /api/v1/report) are working fine.
2. I added print statements in the @expose method and the class constructor, but they don't seem to be executed when the endpoint is called.

I suspect there might be an issue with how Superset is registering custom APIs or a potential misconfiguration on my end. I've also tried enabling Swagger UI (FAB_API_SWAGGER_UI = True) to debug, but the issue persists.

Steps already taken:
Registered custom API in appbuilder.add_api()
Restarted the server after changes
Verified the api.py and init.py implementations

[dosubot[bot]]

I found two similar unsolved discussions that might be relevant to your issue:

1. How to add a custom api? - This discussion involves adding a custom API in Superset and might provide insights into potential pitfalls or configurations that could be affecting your setup ^[1].

2. Apache-Superset -- Adding new endpoint into superset - This thread discusses adding new endpoints and might contain useful information or similar experiences that could help diagnose your issue ^[2].

Regarding your specific issue, ensure that the @expose decorator is correctly set up in your ReportScheduleRestApi class. The @expose decorator is crucial for defining routes, and any misconfiguration here could lead to the endpoint not being registered properly ^[3]. Double-check the path and methods specified in the @expose decorator to ensure they match your intended endpoint configuration. Additionally, verify that there are no typos or mismatches in the endpoint URL or method definitions.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}