New method in router to create CRUD for a Django model.#1712
Open
rroblf01 wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds comprehensive documentation for the new auto-generated Model API feature in Django Ninja. The documentation explains how to quickly generate full CRUD endpoints for any Django model using a single method call, details the generated routes and schemas, and describes all available configuration options. It also covers the async variant for projects using Django's async ORM, provides a full example, and compares the auto-generated API to manual CRUD implementations. Additionally, the new documentation page is integrated into the guides navigation.
Documentation for auto-generated Model API:
guides/model-api.md) detailing how to useadd_model_apiandadd_async_model_apito automatically generate CRUD endpoints for Django models, including descriptions of generated endpoints, schemas, parameters (fields,exclude,operations,tags,auth), and usage examples.Documentation navigation update:
mkdocs.ymlfor easy discoverability.