Correction in the generation of JsonSchemas of object and array type.

SwagDoc library updated.
danieleteti · May 2, 2020 · 4aff893 · 4aff893 · joaoduarte19 · May 2, 2020
1 parent 6c96a6e
commit 4aff893
Show file tree

Hide file tree

Showing 16 changed files with 213 additions and 463 deletions.
diff --git a/lib/swagdoc/Demos/SampleApi/Sample.Api.Employee.pas b/lib/swagdoc/Demos/SampleApi/Sample.Api.Employee.pas
@@ -80,6 +80,7 @@ implementation
 uses
   Json.Schema.Field.Strings,
   Json.Schema.Field.Arrays,
+  Json.Schema.Field.Enums,
   Swag.Common.Types;
 
 { TApiEmployee }
@@ -145,6 +146,7 @@ function TFakeApiEmployee.DocumentEmployeeModelSchema: TJsonSchema;
 var
   vName: TJsonFieldString;
   vAddressSchema: TJsonSchema;
+  vGender: TJsonFieldEnum;
 begin
   Result := TJsonSchema.Create;
   Result.Root.Description := 'Employee response data';
@@ -157,6 +159,11 @@ function TFakeApiEmployee.DocumentEmployeeModelSchema: TJsonSchema;
   Result.AddField<TDate>('hireDate', 'The employee hire date.');
   Result.AddField<Double>('salary', 'The employee gross salary.');
 
+  vGender := Result.AddFieldAsType<TJsonFieldEnum>('gender', 'The employee gender.');
+  vGender.Required := True;
+  vGender.EnumType := etString;
+  vGender.AddItems(['male', 'female']);
+
   vAddressSchema := TJsonSchema.Create;
   try
     vAddressSchema.Root.Name := 'address';

diff --git a/lib/swagdoc/Deploy/swagger.json b/lib/swagdoc/Deploy/swagger.json
@@ -75,7 +75,8 @@
                         "description":"Employee request data",
                         "required":
                         [
-                          "name"
+                          "name",
+                          "gender"
                         ]
 ,
                         "properties":
@@ -112,6 +113,17 @@
                             "type":"number",
                             "description":"The employee gross salary."
                           }
+,
+                          "gender":
+                          {
+                            "type":"string",
+                            "description":"The employee gender.",
+                            "enum":
+                            [
+                              "male",
+                              "female"
+                            ]
+                          }
 ,
                           "address":
                           {
@@ -199,7 +211,8 @@
                   "description":"Employee request data",
                   "required":
                   [
-                    "name"
+                    "name",
+                    "gender"
                   ]
 ,
                   "properties":
@@ -236,6 +249,17 @@
                       "type":"number",
                       "description":"The employee gross salary."
                     }
+,
+                    "gender":
+                    {
+                      "type":"string",
+                      "description":"The employee gender.",
+                      "enum":
+                      [
+                        "male",
+                        "female"
+                      ]
+                    }
 ,
                     "address":
                     {
@@ -320,7 +344,8 @@
                   "description":"Employee request data",
                   "required":
                   [
-                    "name"
+                    "name",
+                    "gender"
                   ]
 ,
                   "properties":
@@ -357,6 +382,17 @@
                       "type":"number",
                       "description":"The employee gross salary."
                     }
+,
+                    "gender":
+                    {
+                      "type":"string",
+                      "description":"The employee gender.",
+                      "enum":
+                      [
+                        "male",
+                        "female"
+                      ]
+                    }
 ,
                     "address":
                     {
@@ -449,7 +485,8 @@
                   "description":"Employee request data",
                   "required":
                   [
-                    "name"
+                    "name",
+                    "gender"
                   ]
 ,
                   "properties":
@@ -486,6 +523,17 @@
                       "type":"number",
                       "description":"The employee gross salary."
                     }
+,
+                    "gender":
+                    {
+                      "type":"string",
+                      "description":"The employee gender.",
+                      "enum":
+                      [
+                        "male",
+                        "female"
+                      ]
+                    }
 ,
                     "address":
                     {
@@ -570,7 +618,8 @@
       "description":"Employee response data",
       "required":
       [
-        "name"
+        "name",
+        "gender"
       ]
 ,
       "properties":
@@ -600,6 +649,17 @@
           "type":"number",
           "description":"The employee gross salary."
         }
+,
+        "gender":
+        {
+          "type":"string",
+          "description":"The employee gender.",
+          "enum":
+          [
+            "male",
+            "female"
+          ]
+        }
 ,
         "address":
         {

diff --git a/lib/swagdoc/Source/Json.Schema.Field.Enums.pas b/lib/swagdoc/Source/Json.Schema.Field.Enums.pas
@@ -31,6 +31,8 @@ interface
   Json.Schema.Common.Types;
 
 type
+  TJsonFieldEnumType = (etNumber, etString);
+
   TJsonFieldEnumItem = class
   strict private
     fValue: Integer;
@@ -46,9 +48,12 @@   TJsonFieldEnumItem = class
   TJsonFieldEnum = class(TJsonField)
   strict private
     fJsonEnumItems: TObjectList<TJsonFieldEnumItem>;
+    fEnumType: TJsonFieldEnumType;
 
     function GetCount: Integer;
     function GetItem(const pIndex: Byte): TJsonFieldEnumItem;
+  strict protected
+    function GetTypeName: string; override;
   public
     constructor Create; override;
     destructor Destroy; override;
@@ -57,10 +62,12 @@   TJsonFieldEnum = class(TJsonField)
     procedure AddItems(const pItemsDescriptions: array of string);
 
     function ToJsonSchema: TJsonObject; override;
+
     function Clone: TJsonField; override;
 
     property Count: Integer read GetCount;
     property Items[const pIndex: Byte]: TJsonFieldEnumItem read GetItem;
+    property EnumType: TJsonFieldEnumType read fEnumType write fEnumType;
   end;
 
 implementation
@@ -84,6 +91,7 @@ constructor TJsonFieldEnum.Create;
 begin
   inherited Create;
   fJsonEnumItems := TObjectList<TJsonFieldEnumItem>.Create(True);
+  fEnumType := etNumber;
 end;
 
 destructor TJsonFieldEnum.Destroy;
@@ -102,14 +110,15 @@ procedure TJsonFieldEnum.AddItems(const pItemsDescriptions: array of string);
   vItemIndex: Integer;
 begin
   for vItemIndex := 0 to Length(pItemsDescriptions) -1 do
-    Self.AddItem(vItemIndex + Self.GetCount, pItemsDescriptions[vItemIndex]);
+    Self.AddItem(vItemIndex, pItemsDescriptions[vItemIndex]);
 end;
 
 function TJsonFieldEnum.Clone: TJsonField;
 var
   vIndex: Integer;
 begin
   Result := inherited Clone;
+  TJsonFieldEnum(Result).EnumType := Self.EnumType;
   for vIndex := 0 to Self.GetCount - 1 do
   begin
     TJsonFieldEnum(Result).AddItem(
@@ -131,6 +140,14 @@ function TJsonFieldEnum.GetItem(const pIndex: Byte): TJsonFieldEnumItem;
     Result := nil;
 end;
 
+function TJsonFieldEnum.GetTypeName: string;
+begin
+  case fEnumType of
+    etNumber: Result := inherited GetTypeName;
+    etString: Result := 'string';
+  end;
+end;
+
 function TJsonFieldEnum.ToJsonSchema: TJsonObject;
 var
   vJsonList: TJsonArray;
@@ -146,10 +163,15 @@ function TJsonFieldEnum.ToJsonSchema: TJsonObject;
     if Assigned(vJsonEnumItem) then
     begin
       vHelpEnum := vHelpEnum + vJsonEnumItem.Value.ToString + '=' + vJsonEnumItem.Description + ', ';
-      vJsonList.Add(vJsonEnumItem.Value);
+      case fEnumType of
+        etNumber: vJsonList.Add(vJsonEnumItem.Value);
+        etString: vJsonList.Add(vJsonEnumItem.Description);
+      end;
     end;
   end;
-  vHelpEnum := fDescription + ' ' + Copy(vHelpEnum, 1, Length(vHelpEnum) - 2) + ']';
+
+  if (fEnumType = etNumber) then
+    fDescription := fDescription + ' ' + Copy(vHelpEnum, 1, Length(vHelpEnum) - 2) + ']';
 
   Result := inherited ToJsonSchema;
   Result.AddPair('enum', vJsonList);

diff --git a/lib/swagdoc/Source/Json.Schema.Field.Objects.pas b/lib/swagdoc/Source/Json.Schema.Field.Objects.pas
@@ -143,6 +143,9 @@ function TJsonFieldObject.Clone(pSourceField: TJsonFieldObject): TJsonFieldObjec
 end;
 
 function TJsonFieldObject.ToJsonSchema: TJsonObject;
+const
+  c_SchemaRef = '$ref';
+  c_PrefixDefinitionName = '#/definitions/';
 var
   vJsonObjectList: TJsonObject;
   vJsonRequiredList: TJsonArray;
@@ -151,7 +154,7 @@ function TJsonFieldObject.ToJsonSchema: TJsonObject;
   if (fRef.Length > 0) then
   begin
     Result := TJSONObject.Create;
-    Result.AddPair('$ref', FRef);
+    Result.AddPair('$ref', c_PrefixDefinitionName + FRef);
     Exit;
   end;
 

diff --git a/lib/swagdoc/Source/Json.Schema.Field.pas b/lib/swagdoc/Source/Json.Schema.Field.pas
@@ -35,13 +35,14 @@   TJsonFieldClass = class of TJsonField;
   TJsonField = class abstract(TPersistent)
   strict private
     fTypeName: string;
-    function GetTypeName: string;
   strict protected
     fName: string;
     fDescription: string;
     fRequired: Boolean;
     fNullable: Boolean;
 
+    function GetTypeName: string; virtual;
+
     property TypeName: string read GetTypeName;
   public
     constructor Create; reintroduce; virtual;

diff --git a/lib/swagdoc/Source/Json.Schema.pas b/lib/swagdoc/Source/Json.Schema.pas
@@ -54,6 +54,7 @@   TJsonSchema = class(TObject)
     function Clone(pSourceField: TJsonSchema): TJsonSchema; overload;
     function AddField<T>(const pName: string; const pDescription: string = ''): TJsonField; overload;
     function AddField(pSchemaObject: TJsonSchema): TJsonField; overload;
+    function AddFieldAsType<T>(const pName: string; const pDescription: string = ''): T;
 
     property Root: TJsonFieldObject read fRoot;
     property Ref: string read GetRef write SetRef;
@@ -191,6 +192,14 @@ function TJsonSchema.AddField<T>(const pName: string; const pDescription: string
   fRoot.AddField(Result);
 end;
 
+function TJsonSchema.AddFieldAsType<T>(const pName, pDescription: string): T;
+var
+  vValue: TValue;
+begin
+  vValue := AddField<T>(pName, pDescription);
+  Result := vValue.AsType<T>;
+end;
+
 function TJsonSchema.Clone(pSourceField: TJsonSchema): TJsonSchema;
 begin
   Result := TJsonSchema.Create;

diff --git a/lib/swagdoc/Source/Swag.Doc.Path.pas b/lib/swagdoc/Source/Swag.Doc.Path.pas
@@ -24,7 +24,7 @@
 
 interface
 
-uses
+uses  
   System.Classes,
   System.Generics.Collections,
   System.RegularExpressions,