FastAPI integration docs - #95
Conversation
grahamalama
left a comment
grahamalama
left a comment
There was a problem hiding this comment.
A few inline comments, and this more higher-level thought:
Some of the documentation we've added feels like documentation of FastAPI vs how to integrate Dockerflow's FastAPI extension into a FastAPI app.
Can we link to FastAPI documentation where appropriate and focus this documentation on aspects that are Dockerflow-specific?
|
|
||
| To facilitate this python-dockerflow comes with a FastAPI view to read the | ||
| file under path the parent directory of the app root. See the | ||
| :class:`FastAPI API docs <~fastapi.FastAPI>` for more information about the |
There was a problem hiding this comment.
Is this supposed to be a link somewhere? If so, looks like it didn't link properly.
There was a problem hiding this comment.
Apparently, we have the same behaviour on Flask docs https://python-dockerflow.readthedocs.io/en/main/flask.html#versions
| .. epigraph:: | ||
|
|
||
| Accept its configuration through environment variables. |
There was a problem hiding this comment.
Does epigraph suggest that this should have more formatting that just an indentation?
There was a problem hiding this comment.
This is like a note... I'd say that it just has some indentation
Co-authored-by: grahamalama <[email protected]>
This is true about all the rest of the documentation I believe, I aligned it with other integrations actually.
Will see what I can do... |
Ahh okay. Well then, I think internal consistency outweighs that feedback I gave. Maybe look for places were we're missing integration docs, but if that spills into FastAPI documentation, so be it. |
* Add tox config for FastAPI 100 * Add dockerflow router to package root * Add request summary middleware * Add version endpoint and tests * Add initial heartbeat route, check mechanism, and tests * Refactor package structure, names of things - Define "router" in package init, register view functions defined in views module - Add test for check with custom name - use better name for check operations * Leverage centralized checks (#85) * Do not test on Python 3.7 * Add 'taskName' to excluded fields * Test with python 3.12 * Improve test coverage of FastAPI * Blackify * FastAPI integration docs (#95) * Add FastAPI documentation * Update docs/fastapi.rst Co-authored-by: grahamalama <[email protected]> * Mention APP_DIR for the version file --------- Co-authored-by: grahamalama <[email protected]> * Update tox.ini Co-authored-by: grahamalama <[email protected]> --------- Co-authored-by: Mathieu Leplatre <[email protected]>
2 participants
Merge into #75