REST istemcilerini elle yazmayı bırakın

1. 1 Bir spesifikasyona yönlendirin

   Bir OpenAPI 3.x belgesini dosyadan, URL'den veya bir metinden, JSON ya da YAML biçiminde yükleyin. Swagger 1.x ve 2.x dosyaları algılanır ve sizin için OpenAPI 3.x modeline dönüştürülür.

2. 2 Ayrıştırın

   TsgcOpenAPIParser, harici dosyalar ve dairesel başvurular dahil olmak üzere $ref işaretçilerini çözer, allOf, oneOf ve anyOf yapılarını düzleştirir ve yapısal hataları satır düzeyinde ayrıntıyla bildirir.

3. 3 Üretin

   TsgcOpenAPIGenerator, etiket başına bir sınıf olacak şekilde gruplanmış, güçlü tipli Pascal sınıfları, kayıtları ve numaralandırmaları üretir, ayrıca kodun yanında PDF ve CHM belgeleri oluşturur.

4. 4 Derleyin

   Üretilen birimleri projeye bırakın. Delphi 7'den RAD Studio 13'e ve C++ Builder 2007'den 13'e kadar, sgcOpenAPI çalışma zamanının dışında hiçbir harici bağımlılık yoktur.

5. 5 Çağırın

   BaseURL değerini ayarlayın, kimlik bilgilerini girin ve işlemi çağırın. Tip güvenli yöntemler, tipli sonuçlar, IDE'de tam IntelliSense.

uses
  sgcOpenAPI_Parser, sgcOpenAPI_Generator;
var
  vParser: TsgcOpenAPIParser;
  vGen: TsgcOpenAPIGenerator;
begin
  vParser := TsgcOpenAPIParser.Create(nil);
  try
    vParser.LoadFromFile('C:\specs\github\api.github.com.json');
    Memo1.Lines.Add(Format('GitHub spec: %d paths, %d schemas',
      [vParser.Paths.Count, vParser.Schemas.Count]));

    vGen := TsgcOpenAPIGenerator.Create(nil);
    try
      vGen.Parser := vParser;
      vGen.OutputUnit := 'sgcOpenAPI_GitHub';
      vGen.OutputFolder := 'C:\Generated\GitHub';
      vGen.GroupBy := gbTag;        // one class per tag
      vGen.Generate;
    finally
      vGen.Free;
    end;
  finally
    vParser.Free;
  end;
end;

uses
  sgcOpenAPI_PetStore;  // Generated from petstore.yaml

procedure TForm1.btnGetPetClick(Sender: TObject);
var
  Client: TsgcOpenAPI_PetStoreClient;
  Pet: TsgcOpenAPI_Pet;
begin
  Client := TsgcOpenAPI_PetStoreClient.Create(nil);
  try
    Client.BaseURL := 'https://petstore.swagger.io/v2';
    Client.ApiKey  := 'your-api-key';

    // Type-safe API call with IntelliSense
    Pet := Client.GetPetById(42);
    try
      Memo1.Lines.Add('Name: '     + Pet.Name);
      Memo1.Lines.Add('Status: '   + Pet.Status);
      Memo1.Lines.Add('Category: ' + Pet.Category.Name);
    finally
      Pet.Free;
    end;
  finally
    Client.Free;
  end;
end;

Ayrıştırıcı ve üretici ayrı bileşenlerdir, bu yüzden ayrıştırılmış modeli kendiniz de gezebilir ve üzerine kendi araçlarınızı kurabilirsiniz. Ayrıştırıcı bileşeni →