[Docs+] Getting Started With MongoDB and FastAPI #250
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
✅ Deploy Preview for docs-pymongo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
rustagir
requested changes
May 5, 2025
| uvicorn app:app --reload | ||
|
|
||
| .. image:: /includes/integrations/fastapi-terminal.png | ||
| :alt: Screenshot of terminal running FastAPI |
There was a problem hiding this comment.
This step has a lot of indentation errors
|
|
||
| All the code for the example application is stored in ``app.py``. | ||
|
|
||
| Connect to your MongoDB Atlas cluster using the asynchronous `Pymongo Driver <https://www.mongodb.com/docs/languages/python/pymongo-driver/current>`__, then specify the database named ``college``: |
There was a problem hiding this comment.
Since this page is now in the pymongo docs, change this link out for something that makes more sense (and use a ref)
Comment on lines
113
to
117
| FastAPI encodes and decodes data as JSON strings, which do not support all of the | ||
| data types that MongoDB's BSON data type can store. BSON has support for | ||
| additional non-JSON-native data types, including ``ObjectId`` which is used for | ||
| the default UUID attribute, ``_id``. Because of this, you must convert | ||
| ``ObjectId`` objects to strings before storing them in the ``_id`` field. |
Comment on lines
126
to
127
| # Represents an ObjectId field in the database. | ||
| # It will be represented as a `str` on the model so that it can be |
There was a problem hiding this comment.
S: move code to file where possible
|
|
||
| This is the primary model we use as the `response model <https://fastapi.tiangolo.com/tutorial/response-model/>`__ for the majority of our endpoints. | ||
|
|
||
| I want to draw attention to the ``id`` field on this model. MongoDB uses ``_id``, but in Python, underscores at the start of attributes have special meaning. If you have an attribute on your model that starts with an underscore, `pydantic <https://pydantic-docs.helpmanual.io/>`__—the data validation framework used by FastAPI—will assume that it is a private variable, meaning you will not be able to assign it a value! To get around this, we name the field ``id`` but give it an alias of ``_id``. You also need to set ``populate_by_name`` to ``True`` in the model's ``model_config`` |
There was a problem hiding this comment.
S: fix for lots of style guide errors
rustagir
requested changes
May 7, 2025
Comment on lines
+197
to
+198
| - It does not have an ``id`` attribute, as this cannot be modified | ||
| - - All fields are optional, so you can supply only the fields you want to update |
| Create Your Application Routes | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Our application has five routes: |
There was a problem hiding this comment.
Suggested change
| Our application has five routes: | |
| The following table describes the application routes you must create to interact with data: |
Comment on lines
+319
to
+320
| The application has two read routes: one for viewing all students, and one | ||
| for viewing an individual student specified by their ``id``. |
Comment on lines
+343
to
+345
| recommend using the `skip and limit parameters | ||
| <https://pymongo.readthedocs.io/en/stable/api/pymongo/asynchronous/collection.html#pymongo.asynchronous.collection.AsyncCollection.find>`__ | ||
| in ``find`` to paginate your results. |
There was a problem hiding this comment.
S: not sure why formatting is off here - also use __ at the end of urls (2 underscores)
Comment on lines
+383
to
+385
| <https://pymongo.readthedocs.io/en/stable/api/pymongo/asynchronous/collection.html#pymongo.asynchronous.collection.AsyncCollection.find_one_and_update>`__ | ||
| to `$set <https://docs.mongodb.com/manual/reference/operator/update/set/>`__ | ||
| the new values, and then return the updated document. |
There was a problem hiding this comment.
Use native links such as source constants for API links and :manual:
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.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-48895
Staging Links
Self-Review Checklist