jupyter / enhancement-proposals

Enhancement proposals for the Jupyter Ecosystem
https://jupyter.org/enhancement-proposals
BSD 3-Clause "New" or "Revised" License
115 stars 65 forks source link

[JEP 0028] Add namespacing to `static` endpoints and REST API urls. #34

Closed Zsailer closed 11 months ago

Zsailer commented 5 years ago

From JEP 0028 (Jupyter Server):

Add namespacing to static endpoints and REST API urls.

Currently, the notebook tornado application serves all static files underneath the /static/ prefix. Jupyter server will add namespacing under the static url and extension REST API urls. Each extension will serve their static files under the /static/<extension-name> prefix and their API handlers behind a /extension/api/<extension-name> prefix.

For example, the classic notebook server extension will add static handlers that reroute requests to the /static/notebook/ endpoints.

A new ExtensionHandler class will be available in jupyter_server.extensions.handlers. This class inherits JupyterHandler. It handles the boilerplate code to reroute requests extension's namespaced static and REST API endpoints.

Preliminary experimental work resides in the jupyter_server_extension repository.

Opening for further discussion.

Zsailer commented 11 months ago

Closing, since this was added in Jupyter Server >= 1.x