sgcOpenAPI 経由の GitHub REST API Delphi クライアント

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

File successfully created github.pas

-i はローカルファイルまたは URL を受け取り、JSON と YAML の両方に対応します。-o は書き出す Pascal ユニットで、ユニット名はそのファイル名から付けられます。-a 2 はトークン認証を選択するので、生成されたメソッドはすべて Authorization: Bearer を送信します。同じ実行ファイルは、パラメーターなしで起動すると GUI ウィザードになります。終了コードは成功で 0、入力ファイルが不正なら 5、出力ファイルが不正なら 6、ドキュメントを有効な OpenAPI 3 ドキュメントに変換できない場合は 7 です。

生成された .pas をプロジェクトに追加し、uses 節に書いてください。インストールするコンポーネントはありません。sgcOpenAPI はコンポーネントを登録せず、設計時パッケージも同梱していないからです。

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;

各レスポンスクラスは Successful に加えて、ドキュメントが宣言するステータスコードごとに 1 つのプロパティを持ちます。そのため、呼び出しが失敗したときに読めるよう Error304、Error401、Error403、Error422 が用意されています。GitHub が名前付きスキーマで記述したステータスはクラスになり、何も記述していないステータスはただの文字列になります。エラープロパティは必要になった時点で生成されるので nil になることはなく、オブジェクトの有無ではなく IsSuccessful を判定します。

_message のアンダースコアは誤記ではありません。message はジェネレーターがエスケープする 68 個の Pascal 予約語の 1 つなので、その名前を持つスキーマフィールドは先頭にアンダースコアが付いた形で現れます。type、object、default、index など残りの語も同じで、そのいずれもが GitHub のスキーマのどこかに出てきます。