ASP.NET Core调用VariantValidator REST API问题求助（入门视角）

Hey there! Let's break down your questions and fix up your code to get this working smoothly.

Q1: Do I need to define all variables in my class model? #

Short answer: No, you don’t have to define every single field returned by the API.

The Newtonsoft.Json library you’re using (JsonConvert.DeserializeObject) will automatically ignore any properties in the API response that don’t match your VariantValidator class. Here’s how to approach this:

• If you only care about specific fields (like gene_symbol or hgvs_transcript_variant), just keep those properties in your class and delete the ones you don’t need. This keeps your model clean and focused.
• If you want to capture all the API’s data, you have two solid options:
  1. Keep your full VariantValidator class as-is – this gives you strong typing, which is great for intellisense and catching bugs early.
  2. Use JObject (from Newtonsoft.Json) to parse the response dynamically, but this loses type safety so it’s not ideal for production.

Q2: How to create a view to pass the {gene_query} parameter to the API? #

You’ll need two simple views to handle user input and display results. Let’s build them step by step:

1. Index View (For User Input) #

This view will show a form where users enter their variant query and submit it to your Getgene action.

<!-- Views/VariantValidator/Index.cshtml -->
@{
    ViewData["Title"] = "Variant Validator";
}

<h1>Validate Your Variant</h1>

<!-- Show service status if you want to check the hello endpoint -->
@if (ViewBag.ServiceStatus != null)
{
    <p class="text-success">Service Status: @ViewBag.ServiceStatus</p>
}

<form asp-action="Getgene" method="post" class="mt-4">
    <div class="mb-3">
        <label for="gene_query" class="form-label">Enter HGVS Variant (e.g., NM_000518.4:c.740C>G):</label>
        <input type="text" class="form-control" id="gene_query" name="gene_query" required placeholder="Type your variant here">
    </div>
    <button type="submit" class="btn btn-primary">Validate Variant</button>
</form>

2. Getgene View (For Displaying Results) #

This view will render the data returned from the VariantValidator API.

<!-- Views/VariantValidator/Getgene.cshtml -->
@{
    ViewData["Title"] = "Validation Results";
}

<h1>Variant Validation Results</h1>

@if (Model != null)
{
    <div class="card mt-3">
        <div class="card-body">
            <h5 class="card-title">Submitted Variant: @Model.submitted_variant</h5>
            <p class="card-text"><strong>Gene Symbol:</strong> @Model.gene_symbol</p>
            <p class="card-text"><strong>HGVS Transcript Variant:</strong> @Model.hgvs_transcript_variant</p>
            <p class="card-text"><strong>Predicted Protein Consequence:</strong> @Model.hgvs_predicted_protein_consequence</p>
            <!-- Add more fields from your VariantValidator class as needed -->
        </div>
    </div>
}
else
{
    <p class="text-danger mt-3">Please enter a valid variant query.</p>
}

<a asp-action="Index" class="btn btn-secondary mt-3">Back to Query</a>

Fixed Controller Code #

Your original controller had a couple of small issues (like HttpClient management and variable scope). Here’s the improved version:

First, register IHttpClientFactory in Program.cs (this is the recommended way to manage HTTP clients in ASP.NET Core to avoid socket exhaustion):

// Program.cs
builder.Services.AddHttpClient();

Then update your controller:

public class VariantValidatorController : Controller 
{ 
    private readonly IHttpClientFactory _httpClientFactory;

    // Inject IHttpClientFactory via constructor
    public VariantValidatorController(IHttpClientFactory httpClientFactory)
    {
        _httpClientFactory = httpClientFactory;
    }

    public async Task<IActionResult> Index() 
    { 
        // Optional: Check if the service is alive and pass status to the view
        var client = _httpClientFactory.CreateClient();
        var response = await client.GetAsync("https://rest.variantvalidator.org/hello/");
        response.EnsureSuccessStatusCode();
        
        string apiResponse = await response.Content.ReadAsStringAsync(); 
        var statusData = JsonConvert.DeserializeObject<Dictionary<string, string>>(apiResponse);
        ViewBag.ServiceStatus = statusData["status"];

        return View(); 
    } 

    [HttpPost] 
    public async Task<IActionResult> Getgene(string gene_query) 
    { 
        if (string.IsNullOrWhiteSpace(gene_query))
        {
            return View(null);
        }

        var client = _httpClientFactory.CreateClient();
        var response = await client.GetAsync($"https://rest.variantvalidator.org/VariantValidator/variantvalidator/{gene_query}");
        
        // Throw an error if the API returns a 4xx/5xx status (you can add try/catch here for better error handling)
        response.EnsureSuccessStatusCode();

        string apiResponse = await response.Content.ReadAsStringAsync(); 
        var variantData = JsonConvert.DeserializeObject<VariantValidator>(apiResponse); 

        return View(variantData); 
    } 
}

Key fixes here:

• Swapped new HttpClient() for IHttpClientFactory to follow best practices
• Fixed the variable scope issue with your API response data
• Added input validation for empty queries
• Added optional service status check for the hello endpoint

内容的提问来源于stack exchange，提问作者Ashkan Pirmani