SwagDoc

Utworzymy dokumentację interfejsu API REST za pomocą Swagger 2.0 dla języka Delphi. Jedynym zadaniem SwagDoc jest wygenerowanie pliku swagger.json. Plik swagger.json odpowiada za przechowywanie całej dokumentacji interfejsu API REST. Ten plik musi być dołączony do plików interfejsu użytkownika Swagger UI (interfejs użytkownika).

W poniższych krokach opiszę w jaki sposób utworzyć dokumentację endpointów w języku Delphi.

1. Przygotowanie dwóch prostych endpointów za pomocą biblioteki wirl
   1. Tworzymy nowy projekt
   2. Instalacja biblioteki wirl
   3. Dodajemy dwa endpointy
2. Przygotowanie kodu dokumentującego nasze endpointy
3. Wygenerowanie pliku swagger.json
4. Wyświetlenie wyników w edytorze swagger

Tworzymy nowy projekt VCL w RAD Studio. File->New->Windows VCL Application

Nasze endpointy będziemy przygotowywać za pomocą zewnętrznej biblioteki WiRL RESTful dla języka Delphi. Pobieramy bibliotekę i dodajemy ją do projektu (Project->Options->Delphi Compiler->Serach path)

git clone https://github.com/delphi-blocks/WiRL.git

Dodajemy dwa endpointy

[Path('customers')]
TCustomerResource = class
public
 [GET]
 [Produces('TMediaType.APPLICATION_JSON')]
 function SelectCustomers: TCustomerList;

 [POST]
 [Consumes('TMediaType.APPLICATION_JSON')]
 [Produces('TMediaType.APPLICATION_JSON')]
 function InsertCustomer(ACustomer: TCustomer): TCustomer;
end;

Następnie możemy przejść do dokumentacji kodu za pomocą biblioteki SwagDoc.