jupyter_server
jupyter_server copied to clipboard
Strawman API Docs
references
- #1418
code changes
- [x] add swagger-ui-dist to
package.json - [x] add
/api/apidocsendpoint
alternatives
- looked at
redocper https://github.com/jupyter-server/jupyter_server/issues/1418#issuecomment-2090954016- has hard-coded tracking logo served from third-party site
- don't feel like hostile-forking it
- also brought in ~100mb of
node_modules
- mounting it on
/api(or evenapi/spec.yaml?docs) would be strictly better, but these both seemed finicky to sniff based on headers, and sometimes be static file or JSON or whatever, and probably not worth the hassle - could be separately configurable, but if you have the rights to access the
spec.yaml
assessment
- this is an important feature
- but not convinced this belongs in core, given the size
- however, an officially-supported extension, potentially with a
jupyter_server[apidocs]would probably be pretty good
screens
| note | screen |
|---|---|
| basic | |
| build-a-GET | |
| GOT | |
| 400% |
:bell: @Zsailer @tonyfast