mirror of
https://github.com/danieleteti/delphimvcframework.git
synced 2024-11-16 00:05:53 +01:00
137 lines
3.9 KiB
ObjectPascal
137 lines
3.9 KiB
ObjectPascal
{ }
|
|
{******************************************************************************}
|
|
{ }
|
|
{ Licensed under the Apache License, Version 2.0 (the "License"); }
|
|
{ you may not use this file except in compliance with the License. }
|
|
{ You may obtain a copy of the License at }
|
|
{ }
|
|
{ http://www.apache.org/licenses/LICENSE-2.0 }
|
|
{ }
|
|
{ Unless required by applicable law or agreed to in writing, software }
|
|
{ distributed under the License is distributed on an "AS IS" BASIS, }
|
|
{ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. }
|
|
{ See the License for the specific language governing permissions and }
|
|
{ limitations under the License. }
|
|
{ }
|
|
{******************************************************************************}
|
|
|
|
unit Sample.SwagDoc;
|
|
|
|
interface
|
|
|
|
uses
|
|
Swag.Doc;
|
|
|
|
type
|
|
TSampleApiSwagDocBuilder = class(TObject)
|
|
strict private
|
|
fSwagDoc: TSwagDoc;
|
|
fDeployFolder: string;
|
|
|
|
procedure DocumentApiInfo;
|
|
procedure DocumentApiSettings;
|
|
procedure DocumentApi;
|
|
procedure DocumentApiEmployee;
|
|
|
|
procedure SaveSwaggerJson;
|
|
private
|
|
procedure SetDeployFolder(const Value: string);
|
|
public
|
|
function Generate: string;
|
|
function SwagDoc: TSwagDoc;
|
|
property DeployFolder: string read fDeployFolder write SetDeployFolder;
|
|
destructor Destroy; override;
|
|
end;
|
|
|
|
implementation
|
|
|
|
uses
|
|
Json.Common.Helpers,
|
|
System.JSON,
|
|
Swag.Common.Types,
|
|
Classes,
|
|
System.SysUtils,
|
|
Swag.Doc.Path.Operation,
|
|
Sample.Api.Employee;
|
|
|
|
{ TSampleApiSwagDocBuilder }
|
|
|
|
function TSampleApiSwagDocBuilder.Generate: string;
|
|
begin
|
|
if Assigned(fSwagDoc) then
|
|
FreeAndNil(fSwagDoc);
|
|
|
|
fSwagDoc := TSwagDoc.Create;
|
|
DocumentApiInfo;
|
|
DocumentApiSettings;
|
|
DocumentApi;
|
|
fSwagDoc.GenerateSwaggerJson;
|
|
SaveSwaggerJson;
|
|
Result := fSwagDoc.SwaggerJson.Format;
|
|
end;
|
|
|
|
procedure TSampleApiSwagDocBuilder.DocumentApiInfo;
|
|
begin
|
|
fSwagDoc.Info.Title := 'Sample API';
|
|
fSwagDoc.Info.Version := 'v1';
|
|
fSwagDoc.Info.TermsOfService := 'http://www.apache.org/licenses/LICENSE-2.0.txt';
|
|
fSwagDoc.Info.Description := 'Sample API Description';
|
|
fSwagDoc.Info.Contact.Name := 'Marcelo Jaloto';
|
|
fSwagDoc.Info.Contact.Email := 'marcelojaloto@gmail.com';
|
|
fSwagDoc.Info.Contact.Url := 'https://github.com/marcelojaloto/SwagDoc';
|
|
fSwagDoc.Info.License.Name := 'Apache License - Version 2.0, January 2004';
|
|
fSwagDoc.Info.License.Url := 'http://www.apache.org/licenses/LICENSE-2.0';
|
|
end;
|
|
|
|
procedure TSampleApiSwagDocBuilder.DocumentApiSettings;
|
|
begin
|
|
fSwagDoc.Host := 'localhost';
|
|
fSwagDoc.BasePath := '/api';
|
|
|
|
fSwagDoc.Consumes.Add('application/json');
|
|
fSwagDoc.Produces.Add('application/json');
|
|
|
|
fSwagDoc.Schemes := [tpsHttp];
|
|
end;
|
|
|
|
destructor TSampleApiSwagDocBuilder.Destroy;
|
|
begin
|
|
FreeAndNil(fSwagDoc);
|
|
inherited;
|
|
end;
|
|
|
|
procedure TSampleApiSwagDocBuilder.DocumentApi;
|
|
begin
|
|
DocumentApiEmployee;
|
|
end;
|
|
|
|
procedure TSampleApiSwagDocBuilder.DocumentApiEmployee;
|
|
var
|
|
vApiEmployee: TFakeApiEmployee;
|
|
begin
|
|
vApiEmployee := TFakeApiEmployee.Create;
|
|
try
|
|
vApiEmployee.DocumentApi(fSwagDoc);
|
|
finally
|
|
vApiEmployee.Free;
|
|
end;
|
|
end;
|
|
|
|
procedure TSampleApiSwagDocBuilder.SaveSwaggerJson;
|
|
begin
|
|
fSwagDoc.SwaggerFilesFolder := fDeployFolder;
|
|
fSwagDoc.SaveSwaggerJsonToFile;
|
|
end;
|
|
|
|
procedure TSampleApiSwagDocBuilder.SetDeployFolder(const Value: string);
|
|
begin
|
|
fDeployFolder := Value;
|
|
end;
|
|
|
|
function TSampleApiSwagDocBuilder.SwagDoc: TSwagDoc;
|
|
begin
|
|
Result := fSwagDoc;
|
|
end;
|
|
|
|
end.
|