django-ninja
django-ninja copied to clipboard
Need more comprehensive Docs/Tutorial like FastAPI
When I check out DRF / FastAPI docs, I find it quite comprehensive with examples given and explained. They seem to be quite clear to understand.
It would be great if we could add a similar level of explanation in Django Ninja Docs.
PS: Just a beginner here, trying to use it over DRF for my project.
Be the change you want to see.
@tushar9sk so what structure you have in mind ?
I would like to pick up this issue and work on it. I am currently building a project with django ninja and i am documenting all my steps and how i made certain things work that were not documented very vaguely.
Please assign me this issue and point me to the guidelines for writing the docs.
I am proposing to:
- Update the tutorial to build a the same app but more elaborate. (Using the app I just built as an inspiration)
- Update the file handling section as it does not cover situations where an endpoint recieves multiple arguments for path arguments, query params, request body, and file simultaneously.
@router.put("/{item_id}", response={200: ItemSchema, 404: ExtraMessage})
def update_item(
request,
item_id: int,
payload: Form[ItemInSchema],
item_image: Optional[UploadedFile] = File(None),
item_video: Optional[UploadedFile] = File(None),
):