Improve Restful API documentation embeded in FastAPI

nicolargo / glances

Glances an Eye on your system. A top/htop alternative for GNU/Linux, BSD, Mac OS and Windows operating systems.

http://nicolargo.github.io/glances/

Other

26.95k stars 1.53k forks source link

Improve Restful API documentation embeded in FastAPI #2632

Open nicolargo opened 11 months ago

nicolargo commented 11 months ago

The Restful API documentation(generated by Glances) is here: https://github.com/nicolargo/glances/blob/develop/docs/api.rst But FastAPI embed an online documentation: http://0.0.0.0:61208/docs#/

The goal is to make the online version as close as possible than the one generated by the Glances.

github-actions[bot] commented 1 month ago

This issue is stale because it has been open for 3 months with no activity.

nicolargo commented 1 month ago

https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/?h=docs#include-the-custom-docs-for-static-files

github-actions[bot] commented 1 month ago

This issue is available for anyone to work on. Make sure to reference this issue in your pull request. :sparkles: Thank you for your contribution ! :sparkles: