RESTClient.NET

A comprehensive C# library for parsing HTTP files with full VS Code REST Client compatibility and ASP.NET Core integration testing capabilities.

✨ Features

• 🔄 VS Code REST Client Compatibility - Full support for standard # @name format
• 🎲 System Variables - Built-in variables ({{$guid}}, {{$randomInt}}, {{$timestamp}}, {{$datetime}})
• ✅ Enhanced Expectations - Parse # @expect-* comments for automated testing
• 🔍 Name-Based API - Complete request lookup and validation
• 🛡️ Robust Error Handling - Detailed validation with clear error messages
• 🧪 ASP.NET Core Integration - Full testing framework with WebApplicationFactory support

📦 Packages

Package	Version	Description
RESTClient.NET.Core		Core HTTP file parsing library
RESTClient.NET.Testing		ASP.NET Core integration testing framework

🚀 Quick Start

Installation

# Core library
dotnet add package RESTClient.NET.Core

# Testing framework  
dotnet add package RESTClient.NET.Testing

Basic Usage

using RESTClient.NET.Core;

var parser = new HttpFileParser();
var httpFile = await parser.ParseAsync("requests.http");

// Get request by name
var loginRequest = httpFile.GetRequestByName("login");
Console.WriteLine($"Method: {loginRequest.Method}");
Console.WriteLine($"URL: {loginRequest.Url}");

// Access expectations
foreach (var expectation in loginRequest.Metadata.Expectations)
{
    Console.WriteLine($"Expectation: {expectation.Type} = {expectation.Value}");
}

ASP.NET Core Integration Testing

using RESTClient.NET.Testing;
using RESTClient.NET.Testing.Assertions;
using Microsoft.AspNetCore.Mvc.Testing;
using Xunit;

public class ApiIntegrationTests : HttpFileTestBase<Program>
{
    public ApiIntegrationTests(WebApplicationFactory<Program> factory) : base(factory) { }

    protected override string GetHttpFilePath() => "HttpFiles/api-requests.http";

    [Theory]
    [MemberData(nameof(HttpFileTestData))]
    public async Task ExecuteRequest_ShouldMeetExpectations(HttpTestCase testCase)
    {
        // Arrange
        var client = Factory.CreateClient();
        var requestMessage = testCase.ToHttpRequestMessage();

        // Act
        var response = await client.SendAsync(requestMessage);

        // Assert - Framework automatically validates expectations
        await HttpResponseAssertion.AssertResponse(response, testCase.ExpectedResponse);
    }

    [Fact]
    public async Task GetSpecificRequest_ShouldWork()
    {
        // Arrange
        var client = Factory.CreateClient();
        var testCase = GetTestCase("login");

        // Act
        var response = await client.SendAsync(testCase.ToHttpRequestMessage());

        // Assert
        Assert.Equal(200, (int)response.StatusCode);
    }
}

HTTP File Example

@baseUrl = https://api.example.com

# @name login
# @expect status 200
# @expect header Content-Type application/json
# @expect body-contains "token"
POST {{baseUrl}}/auth/login HTTP/1.1
Content-Type: application/json
X-Request-ID: {{$guid}}

{
    "username": "user@example.com",
    "password": "secure_password",
    "sessionId": "{{$randomInt 1000 9999}}"
}

📖 Documentation

Getting Started

• 📖 Getting Started Guide - Complete introduction and setup
• 🧪 Integration Testing Guide - ASP.NET Core testing patterns
• 📚 API Reference - Complete API documentation

Reference

• 📝 HTTP File Reference - Complete syntax reference
• 🔧 Troubleshooting Guide - Common issues and solutions
• 💼 Sample Projects - Working examples and templates

Additional Resources

• 📋 Implementation Status - Current development status
• 🔬 Integration Testing Details - Comprehensive testing specifications
• 📄 Product Requirements (PRD) - Detailed project specifications

🧪 Testing

# Run all tests
dotnet test

# Run with coverage
dotnet test --collect:"XPlat Code Coverage"

# Build entire solution
dotnet build vscode-restclient-dotnet.slnx --configuration Release

📋 Requirements

• .NET 8+ (primary target)
• .NET Standard 2.0 (for broader compatibility)
• VS Code REST Client format compatibility

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes and add tests
4. Ensure all tests pass (dotnet test)
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Built with ❤️ for the .NET community