Learn ASP.NET Web API Development: A Practical Guide with Integration Tests and Testcontainers

Are you looking for a hands-on guide to building robust web applications using modern .NET technologies? This in-depth tutorial provides a practical demonstration of software development best practices, covering everything from building a minimal Web API to advanced testing scenarios. Whether you are a beginner or an experienced developer, this repository offers valuable insights and techniques to enhance your skills.

What You'll Discover

• Minimal Web API Development: Learn to build a lightweight API using ASP.NET.
• Effective Integration Testing: Write clean and reliable integration tests to ensure application quality.
• Advanced Testing with Testcontainers: Utilize Testcontainers for seamless testing with containerized dependencies.
• Modern System Design: Implement practical system design principles for scalable applications.

Ready to dive in? Let's get started.

1. Setting Up Your Development Environment

Get your local environment ready to run and test the REST API with these simple steps.

• Clone the Repository:

  git clone https://github.com/dorinandreidragan/books-inventory.git
  

  Copy
  Cloning gets all of the projects files to your computer.
• Navigate to the Project Directory: Change directory to your newly cloned folder.
• Start Services with Docker Compose: Use Docker to manage dependencies and environment.
• Initialize the Database:

  dotnet ef database update --project src/BooksInventory.WebApi/BooksInventory.WebApi.csproj
  

  Copy
  Keep your database up-to-date with this code.
• Build and Run the Application:

  dotnet run --project src/BooksInventory.WebApi/BooksInventory.WebApi.csproj
  

  Copy
  This builds and runs your project locally.
• Explore the API: Test the API endpoints using the provided HTTP file in VS Code REST Client or your preferred tool.

2. Building the Project

Ready to compile the project? Make sure you have the .NET SDK installed. Then, execute the following command:

• Build Command:

  dotnet build
  

  Copy

3. Testing Your Application

Quality is key. Run these tests to ensure your application is robust and reliable.

• Run Tests Command:

  dotnet test
  

  Copy

Types of Tests Included

• Web API Integration Tests: Verify the interaction between different parts of your API.
• Testcontainers Integration: Perform reliable testing with containerized PostgreSQL database.

4. Continuous Integration with GitHub Actions

Keep your codebase stable with automated testing. Every pull request and commit triggers the CI pipeline.

• CI Pipeline Definition: The CI pipeline is defined in .github/workflows/ci.yml.
• Automated Testing: Ensures code stability by automatically running tests.

5. Explore the Documentation

Deepen your understanding with detailed guides and tutorials.

Available Episodes

• Episode 1: Testing Minimal Web APIs with ASP.NET
• Episode 2: Get Ready for Testcontainers

More episodes are coming soon!

6. Key Features

Benefit from these modern software development practices.

• ASP.NET Minimal Web API: Build lightweight and modern APIs.
• Integration Testing: Ensure reliability with comprehensive tests.
• Testcontainers: Simplify testing with containerized dependencies.
• System Design: Design scalable and maintainable systems.

7. Contribute to the Project

Make this project better together! Submit pull requests, report bugs, or suggest new features. Contributions are greatly appreciated.

8. License

This project is licensed under the MIT License.

9. Acknowledgments

Thank you to all contributors and the open-source community. Your support makes this project possible.