How to integrate MongoDB in ASP .Net Core Web API

In just 9 steps you can configure and setup Web API for making successful API calls to MongoDB Cloud Database:

1. Configure MongoDB Cluster.
1. Create a new Project if you have not created yet (You can also use any other projects).
2. Click on the project that you want to connect to Web API then create a cluster by clicking on The big button "Build a Database":
1. Select the correct options
2. Select the correct provider
3. Select the correct region
4. Give a good Cluster name
5. Give a good username and password
6. Select the correct environment type
7. Add the correct IP address. It also automatically detects the IP address of the machine with which you configure MongoDB But if you use the MongoDB in another machine then you have to add the IP address of that machine as well.
3. Click on the "Connect" button inside your MongoDB Cluster to configure the MongoDB Cluster
1. Select the driver(C# .Net)
2. Select the latest version
3. Copy the connection string and replace the "<password>" with the actual user Password
4. Create Database
1. Click on the tab button "Collections"
2. Click on the button "Add My Own Data"
3. Give a Database name and Collection name (You need these names later when you setup Web API)
4. When you have Database and collection(basically Table), you can add fields(columns) to your collection or table.
5. By Default your collection has only on field(that is the "_id")
6. Add new fields by clicking on "Insert Document"
7. Choose the correct data type for your fields
2. Now you are done in MongoDB, let's jump to the Visual Studio
3. Create a new project if you do not have any(it can be only Web API project or combination of Web API and other types like MVC or React.js frontend,...)
4. Add a new object inside "appsettings.json" to store the MongoDB data: Copy
   
   // In my case the Connection string is "Connection", // the Database name is "DatabaseName", // and the Collection name is CollectionName. You can name them whatever you like. "ConnectionStrings": { "CollectionName": "students", "DatabaseName": "aqyanoosDB", "Connection": "mongodb+srv://school1:<password>@school-cluster.3wo8xzy.mongodb.net/?retryWrites=true&w=majority" }
5. Add middleware for mongodb in "Program.cs": Copy
   
   // Add the following code right below the comment that says // Add services to the container." // DatabaseSettings is the model for the Database object inside "appsettings.json" // ConnectionStrings is the name of the object inside "appsettings.json" for MongoDB // StudentServices is the class with all the services to communicate with MongoDB // In case there are errors: Manually import the DatabaseSettings and StudenServices(The naming is because my YouTube tutorial was about Student management) builder.Services.Configure<DatabaseSettings>( builder.Configuration.GetSection("ConnectionStrings")); builder.Services.AddSingleton<StudentServices>();
6. The Code For "DatabaseSettings.cs": Copy
   
   namespace WebApiMongoDB.Data { public class DatabaseSettings { public string CollectionName { get; set; } public string DatabaseName { get; set; } public string Connection { get; set; } } }
7. The Code For "Student.cs". Student is for example the name of your collection inside MongoDB and based on your collection you need to create a model in Web API: Copy
   
   using MongoDB.Bson; using MongoDB.Bson.Serialization.Attributes; namespace WebApiMongoDB.Models { [BsonIgnoreExtraElements] public class Student { [BsonId] [BsonRepresentation(BsonType.ObjectId)] public string Id { get; set; } = string.Empty; [BsonElement("firstname")] public string FirstName { get; set; } = "Student First Name"; [BsonElement("lastname")] public string LastName { get; set; } = "Student Last Name"; [BsonElement("department")] public string Department { get; set; } = "Department"; [BsonElement("class")] public string ClassName { get; set; } = "Class Name"; [BsonElement("gender")] public byte Gender { get; set; } = 1; [BsonElement("birthday")] public DateTime DateOfBirth { get; set; } [BsonElement("age")] public int Age { get; set; } [BsonElement("graduated")] public bool IsGraduated { get; set; } } }
8. The Code For "StudentServices.cs". Student is for example the name of your collection inside MongoDB. It is best practice to keep everything separated(one service for one collection): Copy
   
   using Microsoft.Extensions.Options; using MongoDB.Driver; using WebApiMongoDB.Data; using WebApiMongoDB.Models; namespace WebApiMongoDB.Services { public class StudentServices { private readonly IMongoCollection<Student> _studentCollection; public StudentServices(IOptions<DatabaseSettings> settings) { var mongoClient = new MongoClient(settings.Value.Connection); var mongoDb = mongoClient.GetDatabase(settings.Value.DatabaseName); _studentCollection = mongoDb.GetCollection<Student>(settings.Value.CollectionName); } // get all students public async Task<List<Student>> GetAsync() => await _studentCollection.Find(_ => true).ToListAsync(); // get student by id public async Task<Student> GetAsync(string id) => await _studentCollection.Find(x => x.Id == id).FirstOrDefaultAsync(); // add new student public async Task CreateAsync(Student newStudent) => await _studentCollection.InsertOneAsync(newStudent); // update student public async Task UpdateAsync(string id, Student updateStudent) => await _studentCollection.ReplaceOneAsync(x=> x.Id == id, updateStudent); // delete student public async Task RemoveAsync(string id)=> await _studentCollection.DeleteOneAsync(x=> x.Id == id); } }
9. The Code For "StudentController.cs". Student is for example the name of your collection inside MongoDB. It is best practice to keep everything separated(one controller for one collection): Copy
   
   using Microsoft.AspNetCore.Mvc; using WebApiMongoDB.Models; using WebApiMongoDB.Services; // For more information on enabling Web API for empty projects, visit https://go.microsoft.com/fwlink/?LinkID=397860 namespace WebApiMongoDB.Controllers { [Route("api/student")] [ApiController] public class StudentController : ControllerBase { private readonly StudentServices _studentServices; public StudentController(StudentServices studentServices) { _studentServices = studentServices; } // GET: api/student [HttpGet] public async Task<List<Student>> Get() => await _studentServices.GetAsync(); // GET api/student/64a51019c925955cfda51194 [HttpGet("{id:length(24)}")] public async Task<ActionResult<Student>> Get(string id) { Student student = await _studentServices.GetAsync(id); if(student == null) { return NotFound(); } return student; } // POST api/student [HttpPost] public async Task<ActionResult<Student>> Post(Student newStudent) { await _studentServices.CreateAsync(newStudent); return CreatedAtAction(nameof(Get), new {id = newStudent.Id}, newStudent); } // PUT api/student/64a51019c925955cfda51194 [HttpPut("{id:length(24)}")] public async Task<ActionResult> Put(string id, Student updateStudent) { Student student = await _studentServices.GetAsync(id); if(student == null) { return NotFound("There is no student with this id: "+ id); } updateStudent.Id = student.Id; await _studentServices.UpdateAsync(id, updateStudent); return Ok("Updated Successfully"); } // DELETE api/student/64a51019c925955cfda51194 [HttpDelete("{id:length(24)}")] public async Task<ActionResult> Delete(string id) { Student student = await _studentServices.GetAsync(id); if (student == null) { return NotFound("There is no student with this id: " + id); } await _studentServices.RemoveAsync(id); return Ok("Deleted Successfully"); } } }