{"id":4607,"date":"2022-08-19T07:50:06","date_gmt":"2022-08-19T14:50:06","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/cosmosdb\/?p=4607"},"modified":"2022-09-19T05:09:04","modified_gmt":"2022-09-19T12:09:04","slug":"azure-cosmos-db-python-and-fastapi","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/cosmosdb\/azure-cosmos-db-python-and-fastapi\/","title":{"rendered":"Write a Python data layer with Azure Cosmos DB and FastAPI"},"content":{"rendered":"

In this article, we will demonstrate how to build a data layer in Python for Azure Cosmos DB<\/a> using FastAPI,<\/a> a web framework for building and testing Python APIs.<\/p>\n

To demonstrate this, we will leverage the To Do App Quickstart in our docs.<\/a> This app shows simple CRUD operations (insert, update, list and delete<\/em>) using a simple data model for a To-Do item consisting of id, name, description,<\/em> and isComplete <\/em>fields. The application that we will create, will wrap these CRUD operations and expose them through a set of custom APIs (Application Programming Interfaces) using the FastAPI routing feature. We will then test our custom APIs in Swagger<\/a> UI that comes pre-packaged with FastAPI.<\/p>\n

<\/i>Find complete code in Github<\/strong><\/p> The code related to this tutorial can be found in our Azure Cosmos DB With FastAPI Tutorial Repo<\/a>.<\/div><\/p>\n

Here’s a complete list of steps we are going to follow to create and test our new backend data access layer.:<\/p>\n

    \n
  1. Create an Azure Cosmos DB account<\/li>\n
  2. Setup the dev environment<\/li>\n
  3. Creating .env file for credentials<\/li>\n
  4. Connect to account, create database and container<\/li>\n
  5. Define our ToDoItem data model<\/li>\n
  6. Setup the API endpoint implementation<\/li>\n
  7. Write our CRUD operations<\/li>\n
  8. Register the API endpoints with FastAPI<\/li>\n
  9. Test the endpoints<\/li>\n<\/ol>\n

    Step 1 \u2013 Create an Azure Cosmos DB account<\/h2>\n

    In a new web browser window or tab, navigate to the Azure portal (portal.azure.com<\/a>).<\/p>\n

      \n
    1. Sign-in into the Azure Portal<\/a> using the credentials associated with your subscription.<\/li>\n
    2. Select Create a resource, search for Azure Cosmos DB, and then create a new Azure Cosmos DB SQL API account resource with the following settings, leaving all remaining settings to their default values:\n\n\n\n\n\n\n\n\n
      Setting<\/strong><\/td>\nValue<\/strong><\/td>\n<\/tr>\n
      Subscription<\/em><\/td>\nYour existing Azure subscription<\/em><\/td>\n<\/tr>\n
      Resource group<\/em><\/td>\nSelect an existing or create a new resource group<\/em><\/td>\n<\/tr>\n
      Account Name<\/em><\/td>\nEnter a globally unique account name<\/em><\/td>\n<\/tr>\n
      Location<\/em><\/td>\nChoose any available region<\/em><\/td>\n<\/tr>\n
      Capacity mode<\/em><\/td>\nServerless<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

      Below is a screenshot showing these settings in the Azure Portal, click Review+Create and follow subsequent process.<\/p>\n

      \"Image<\/a>
      Azure Cosmos DB Account configuration<\/figcaption><\/figure><\/p>\n

       <\/li>\n

    3. Wait for the deployment task to <\/span>complete before continuing with further steps.\n<\/span><\/span>\"Image<\/a><\/li>\n
    4. Go to the newly created Azure Cosmos DB account resource and navigate to the Keys pane.<\/li>\n
    5. The “Keys” section contains the connection details and credentials necessary to connect to the account from the SDK. Specifically:\n