Hubungan antara C # dan C #: REST, gRPC dan semua yang ada di antaranya

Skenario optimal

// 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;
    }
}

• Kelas statis dengan metode statis saja.
• Kelas POCO di mana tidak ada apa pun selain bidang dan properti yang jenisnya adalah kelas POCO primitif atau lainnya.

Pendekatan REST tradisional

• GET digunakan untuk mendapatkan sumber daya
• PUT digunakan untuk mengubah status sumber daya.
• POST digunakan untuk membuat sumber daya.
• HAPUS digunakan untuk menghapus sumber daya.

[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);

Mereparasi

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");

Kesombongan

• Semua jalur (URL) di API.
• Operasi yang diharapkan (GET, POST, ...) untuk setiap jalur. Setiap jalur dapat menangani operasi yang berbeda. Misalnya, jalur yang sama mystore.com/Product dapat menerima operasi POST yang menambahkan produk dan operasi GET yang mengembalikan produk.
• Parameter yang diharapkan untuk setiap jalur dan operasi.
• Jawaban yang diharapkan untuk setiap jalur.
• Jenis setiap parameter dan objek respons.

{ 
   "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"
                     }
                  }
               },
...
 

Menambahkan Swagger ke ASP.NET Server Anda

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)
{
    //...
}

Menghasilkan klien dari Swagger menggunakan AutoRest

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 tradisional vs Swagger vs ReFit

• Jika Anda memiliki REST API pribadi yang sangat sederhana, Anda mungkin tidak perlu khawatir tentang pembuatan klien dan antarmuka umum. Tugas kecil tidak membenarkan upaya tambahan.
• Swagger mendukung banyak bahasa, dan ReFit hanya mendukung .NET. Kesombongan juga menjadi dasar bagi banyak alat, pengujian, alat otomatisasi, dan alat antarmuka pengguna. Ini mungkin akan menjadi pilihan terbaik jika Anda membuat API publik yang besar.
• Kesombongan jauh lebih rumit daripada ReFit. Dengan ReFit, itu hanya masalah menambahkan antarmuka tunggal untuk proyek server dan klien Anda. Di sisi lain, dengan ReFit Anda harus membuat antarmuka baru untuk setiap pengontrol, sementara Swagger akan mengurus ini secara otomatis.

gRPC

• Seperti REST, gRPC independen terhadap bahasa. Ada alat untuk semua bahasa populer, termasuk C #.
• gRPC berbasis kontrak dan menggunakan file .proto untuk mendefinisikan kontrak. Ini agak mirip dengan Swagger swagger.json dan antarmuka ReFit yang umum. Klien dari bahasa pemrograman apa pun dapat dihasilkan dari file-file ini.
• 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 .

GRPC untuk sisi server .NET

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>

GRPC untuk sisi klien NET

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 vs REST

Cara komunikasi lainnya

• GraphQL adalah bahasa permintaan API yang dikembangkan oleh Facebook. Ini memungkinkan klien untuk meminta data yang dibutuhkan dari server. Dengan demikian, Anda dapat membuat hanya satu titik akhir di server, yang akan sangat fleksibel dan hanya akan mengembalikan data yang dibutuhkan klien. GraphQL telah menjadi sangat populer dalam beberapa tahun terakhir.
• TcpClient TcpListener ( System.Net.Sockets) TCP. , . , ASP.NET API.
• UdpClient UDP. TCP , UDP . TCP , , UDP — . UDP , , . : , IP (VoIP).
• WCF adalah teknologi lama yang terutama menggunakan komunikasi antar-proses berbasis SOAP. Ini adalah kerangka kerja besar yang tidak akan saya bahas, saya hanya bisa mengatakan bahwa itu telah kehilangan popularitasnya untuk muatan REST dan JSON.