C# Compass

Examples

C# API Testing

Testing an API

C# API testing with TestServer validates REST endpoints.

Introduction to TestServer

TestServer is a flexible testing framework provided by Microsoft that allows developers to create in-memory testing environments for ASP.NET Core applications. It is an excellent choice for validating REST API endpoints without the need for deploying the application.

Setting Up TestServer in a C# Project

To use TestServer in your C# project, you'll need to add the Microsoft.AspNetCore.TestHost package. This package provides the necessary components to set up TestServer.

Creating a Test for a REST Endpoint

Once TestServer is set up, you can create tests for your REST endpoints. Below is an example of how to test a simple GET endpoint using TestServer and the Xunit testing framework.

Understanding the Test Code

In the example above, WebApplicationFactory is used to create a test server instance for your application. The Get_Endpoint_ReturnsSuccessAndCorrectContentType method tests a GET request to the /api/values endpoint. It checks if the response is successful and if the content type is JSON.

Advanced TestServer Setup

For more advanced scenarios, you can customize the WebApplicationFactory to configure services, middleware, or other settings. This flexibility allows you to simulate different environments or scenarios for your API testing.

Examples

Next
Logging Setup