C# WebApi 接口返回值不困惑：返回值类型详解

下面是 C# WebApi 接口返回值类型详解的完整攻略。

1. 前言

在开发 C# WebApi 的过程中，很重要的一部分就是定义接口返回值类型。定义清晰明确的返回值类型是非常重要的，它会影响到接口调用的正确性及可靠性，同时也会影响到客户端的使用体验。

本文将对 C# WebApi 的返回值类型进行详细讲解，让大家更清晰地理解这个概念。

2. 常用返回值类型

以下是 C# WebApi 中常用的返回值类型：

2.1 string

public string GetString()
{
    // 返回一个字符串
    return "Hello World";
}

2.2 int

public int GetInt()
{
    // 返回一个整数
    return 100;
}

2.3 bool

public bool GetBool()
{
    // 返回一个布尔值
    return true;
}

2.4 自定义类型

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public Person GetPerson()
{
    // 返回一个自定义类型
    return new Person { Name = "Tom", Age = 18 };
}

2.5 IEnumerable<T>

public IEnumerable<string> GetStringList()
{
    // 返回一个字符串列表
    return new List<string> { "Hello", "World" };
}

2.6 HttpResponseMessage

public HttpResponseMessage GetResponse()
{
    // 返回一个自定义的响应
    var response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = new StringContent("Hello World");
    return response;
}

3. 返回值的用法

在 C# WebApi 中，返回值的用法非常灵活，可以根据实际情况进行使用。

在一般的情况下，我们可以直接返回一个具体的值，例如：

public string GetString()
{
    return "Hello World";
}

public int GetInt()
{
    return 100;
}

在一些需要返回状态码的接口中，我们也可以使用 HttpResponseMessage 来定义返回结果：

public HttpResponseMessage GetResponse()
{
    var response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = new StringContent("Hello World");
    return response;
}

在需要返回一个自定义类型的接口中，我们可以直接返回一个自定义类型的对象：

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public Person GetPerson()
{
    return new Person { Name = "Tom", Age = 18 };
}

4. 总结

在 C# WebApi 中，返回值类型的定义非常重要，需要根据实际情况进行灵活调整，以提高接口的可靠性与可用性。通过本文的介绍，相信大家对 C# WebApi 的返回值类型有了更加深入的理解。

示例1、 示例2 使用的是我在本地自己创建的方法，用来说明不同返回类型的用处， 如果你需要试试这份代码，可以下载 -> https://github.com/OPSTLLC/CSharpWebApi_ReturnValue_Demo 运行。