-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Switch to FastAPI and move documentation #21
Comments
n.b. it means we can avoid the odd dependency on a fork of Flask-RESTx: https://github.com/anjackson/flask-restx in order to support HTTP 451 (#11 and https://github.com/anjackson/flask-restx/tree/patch-1 still awaiting python-restx/flask-restx#263) |
The fastapi branch has a work-in-progress implementation. |
Note this helpful advice on running FastAPI on Uvicorn behind NGINX https://www.uvicorn.org/deployment/ |
The FAST API branch is now largely functional, and passes all but two tests from the (updated in coordination) API test suite. The gaps are the crawl stats file, and that the Mementos WARC API just gives the closest match rather than redirecting to the closest match. See To Dos above. |
Okay, now live with the FastAPI version of the original services, but not everything outlined above has been done yet. |
FastAPI is a modern and widely-used framework for Python APIs with autogenerated OpenAPI documentation. This components could easily be switched to that, and used to generate the basic API docs. The detailed documentation, including examples etc., should be moved to
ukwa-documentation
where it can be edited and localised without messing with the live service.prometheus_multiproc_dir
and the Python client docs.httpx
anditer_bytes
consistently overrequests
https://www.python-httpx.org/async/ - prevents worker lockup.The text was updated successfully, but these errors were encountered: