sgcOpenAPI ile GitHub REST API Delphi İstemcisi

> sgcOpenAPI.exe -i "api.github.com.json" -o "github.pas" -a 2

File successfully created github.pas

-i yerel bir dosya ya da bir URL alır, JSON ve YAML kabul eder. -o yazılacak Pascal birimidir ve birim bu dosyanın adını taşır. -a 2 belirteç kimlik doğrulamasını seçer, böylece üretilen her metot Authorization: Bearer gönderir. Aynı çalıştırılabilir dosya, parametresiz başlatıldığında bir grafik sihirbazdır ve başarıda 0, hatalı giriş dosyasında 5, hatalı çıkış dosyasında 6, belge geçerli bir OpenAPI 3 belgesine dönüştürülemediğinde 7 koduyla çıkar.

Üretilen .pas dosyasını projenize ekleyin ve uses bölümüne koyun. Kurulacak bir bileşen yoktur, çünkü sgcOpenAPI hiçbir bileşen kaydetmez ve tasarım zamanı paketi sunmaz.

var
  oIssue: TsgcOpenAPI_issuescreate_Response;
  oPulls: TsgcOpenAPI_pullslist_Response;
begin
  oIssue := GetOpenAPIClient.issuescreate('octocat', 'Hello-World',
    '{"title":"Memory leak in the HTTP/2 reader",' +
    '"body":"Repro steps: ...","labels":["bug","http2"]}');
  try
    if oIssue.IsSuccessful then
      memoLog.Lines.Add('filed issue #' +
        IntToStr(oIssue.Successful.Number) + ' ' + oIssue.Successful.Html_url)
    else
      memoLog.Lines.Add(oIssue.Error422._message);
  finally
    oIssue.Free;
  end;

  oPulls := GetOpenAPIClient.pullslist('octocat', 'Hello-World',
    'open', 'updated');
  try
    memoLog.Lines.Add(IntToStr(oPulls.ResponseCode));
  finally
    oPulls.Free;
  end;
end;

Her yanıt sınıfı, Successful özelliğinin yanı sıra belgenin bildirdiği her durum kodu için bir özellik taşır, bu yüzden çağrı başarısız olduğunda okumak üzere Error304, Error401, Error403 ve Error422 oradadır. GitHub'ın adlandırılmış bir şemayla tanımladığı bir durum bir sınıfa dönüşür, hiçbir şeyle tanımlamadığı bir durum ise düz bir dizeye dönüşür. Hata özelliği ihtiyaç duyuldukça oluşturulur, dolayısıyla hiçbir zaman nil olmaz ve nesneyi sınamak yerine IsSuccessful özelliğini sınarsınız.

_message içindeki alt çizgi bir yazım hatası değildir. message, kod üreticisinin kaçış uyguladığı 68 Pascal ayrılmış sözcüğünden biridir, bu yüzden bu ada sahip bir şema alanı başında alt çizgiyle gelir. Aynısı type, object, default, index ve listenin geri kalanı için de olur, hepsi GitHub'ın şemalarının bir yerinde karşınıza çıkar.