C＃和C＃之间的关系：REST，gRPC及其之间的所有内容

最佳方案

// on client side
public void Foo()
{
    var server = new MyServer(new Uri("https://www.myserver.com/");)
    int sum = server.Calculator.SumNumbers(12,13); 
}

// on server side
class CalculatorController : Controller{
    public int SumNumbers(int a, int b)
    {
        return a + b;
    }
}

• 仅带有静态方法的静态类。
• POCO类，其中只有类型为基本类型或其他POCO类的字段和属性。

传统REST方法

• GET用于获取资源
• PUT用于更改资源的状态。
• POST用于创建资源。
• DELETE用于删除资源。

[Route("People")]
public class PeopleController : Controller
{
    [HttpGet]
    public Person GetPersonById(int id)
    {
        Person person = _db.GetPerson(id);
        return person;//Automatically serialized to JSON
    }
} 

var client = new HttpClient();
string resultJson = await client.GetStringAsync("https://www.myserver.com/People/GetPersonById?id=123");
Person person = JsonConvert.DeserializeObject<Person>(resultJson);

改装

public interface IMyEmployeeApi
{
    [Get("/employee/{id}")]
    Task<Employee> GetEmployee(string id);
}

var api = RestService.For<IMyEmployeeApi>("https://www.myserver.com");
var employee = await api.GetEmployee("abc");

昂首阔步

• API中的所有路径（URL）。
• 每个路径的预期操作（GET，POST等）。每个路径可以处理不同的操作。例如，相同的路径mystore.com/Product可以接受添加产品的POST操作和返回产品的GET操作。
• 每个路径和操作的预期参数。
• 每个路径的预期答案。
• 每个参数和响应对象的类型。

{ 
   "swagger":"2.0",
   "info":{ 
      "version":"1.0.0",
      "title":"Swagger Petstore",
      "description":"A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
   },
   "host":"petstore.swagger.io",
   "basePath":"/api",
   "schemes":[ 
      "http"
   ],
   "consumes":[ 
      "application/json"
   ],
   "produces":[ 
      "application/json"
   ],
   "paths":{ 
      "/pets":{ 
         "get":{ 
            "description":"Returns all pets from the system that the user has access to",
            "operationId":"findPets",
            "produces":[ 
               "application/json",
               "application/xml",
            ],
            "parameters":[ 
               { 
                  "name":"tags",
                  "in":"query",
                  "description":"tags to filter by",
                  "required":false,
                  "type":"array",
                  "items":{ 
                     "type":"string"
                  },
                  "collectionFormat":"csv"
               },
               { 
                  "name":"limit",
                  "in":"query",
                  "description":"maximum number of results to return",
                  "required":false,
                  "type":"integer",
                  "format":"int32"
               }
            ],
            "responses":{ 
               "200":{ 
                  "description":"pet response",
                  "schema":{ 
                     "type":"array",
                     "items":{ 
                        "$ref":"#/definitions/Pet"
                     }
                  }
               },
...
 

将Swagger添加到ASP.NET Server

services.AddSwaggerGen(options => 
	options.SwaggerDoc("v1", new OpenApiInfo {Title = "My Web API", Version = "v1"}));

app.UseSwagger();

[HttpPost]
public async Task AddEmployee([FromBody]Employee employee)
{
    //...
}
 
[HttpGet]
public async Task<Employee> Employee([FromQuery]string id)
{
    //...
}

使用AutoRest从Swagger生成客户端

autorest --input-file="./swagger.json" --output-folder="GeneratedClient" --namespace="MyClient" --override-client-name="MyClient" --csharp

var client = new MyClient();
Employee employee = client.Employee(id: "abc");

传统REST vs Swagger vs ReFit

• 如果您有一个非常简单的私有REST API，则可能不必担心客户端的生成和通用接口。一项小任务并不能证明付出额外的努力。
• Swagger支持多种语言，而ReFit仅支持.NET。Swagger还是许多工具，测试，自动化工具和用户界面工具的基础。如果要创建大型公共API，这可能是最佳选择。
• Swagger比ReFit复杂得多。使用ReFit，只需在服务器和客户端项目中添加一个接口即可。另一方面，使用ReFit，您将必须为每个控制器创建新接口，而Swagger将自动处理此接口。

gRPC

• 像REST一样，gRPC是独立于语言的。有适用于所有流行语言的工具，包括C＃。
• gRPC基于合同，并使用.proto文件定义合同。这有点类似于Swagger swagger.json和常见的ReFit接口。可以从这些文件中生成任何编程语言的客户端。
• gRPC Protocol Buffer (Protobuf). REST, JSON XML. , , .
• gRPC HTTP/2. . , REST HTTP 1.x ( HTTP 1.1).
• HTTP 1.1 TCP- () , HTTP/2 .
• HTTP/2 . , TCP- . , , HTTP 1.1.
• gRPC .

.NET服务器端的GRPC

public class GreeterService : Greeter.GreeterBase
{
    public override Task<HelloReply> SayHello(HelloRequest request,
        ServerCallContext context)
    {
        _logger.LogInformation("Saying hello to {Name}", request.Name);
        return Task.FromResult(new HelloReply 
        {
            Message = "Hello " + request.Name
        });
    }
}

app.UseEndpoints(endpoints =>
{
    endpoints.MapGrpcService<GreeterService>();
});

syntax = "proto3";
 
service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply);
}
 
message HelloRequest {
  string name = 1;
}
 
message HelloReply {
  string message = 1;
}

<ItemGroup>
  <Protobuf Include="Protos\greet.proto"/>
</ItemGroup>

.NET客户端的GRPC

var channel = GrpcChannel.ForAddress("https://localhost:5001");
var client = new Greeter.GreeterClient(channel);
 
var response = await client.SayHello(
    new HelloRequest { Name = "World" });
 
Console.WriteLine(response.Message);

gRPC与REST

其他沟通方式

• GraphQL是Facebook开发的一种API查询语言。这允许客户端从服务器确切地请求它需要的数据。因此，您只能在服务器上创建一个端点，这将非常灵活，并且仅返回客户端需要的数据。近年来，GraphQL变得非常流行。
• TcpClient TcpListener ( System.Net.Sockets) TCP. , . , ASP.NET API.
• UdpClient UDP. TCP , UDP . TCP , , UDP — . UDP , , . : , IP (VoIP).
• WCF是一种旧技术，主要使用基于SOAP的进程间通信。这是一个我不会讨论的庞大框架，我只能说它在REST和JSON负载中已经失去了流行性。