Documentation for DataTables defined in services

[tstoicescu]

Hello,

Is it possible to view the documentation for public DataTable (fields, description, etc.) as can view the documentation for the structures, enums, methods and params, etc. defined in the data services?

[EvgenyK (Evgeny Karpov)]

you can use Description property of fields:

in design-time, it will be shown in Object Inspector as

[tstoicescu]

I need to view this documentation as a html page ex: localhost:8099/doc like for RemObject Services or save all DataTables documentation for a schema as a file.

[EvgenyK (Evgeny Karpov)]

we have no such feature, but you can easily implement this by yourself:

• using HTTPServer.OnCustomResponseEvent you can add a new path like http://localhost:8099/dadoc . see example at Using OnCustomResponseEvent in a ROSDK Server
• inside HTTPServer.OnCustomResponseEvent you can return required documentation. You can create documentation like

daservice := TDataService.Create(nil);
try
  for i := 0 to daservice.ServiceSchema.Datasets.Count-1 do begin
     dataset := daservice.ServiceSchema.Datasets[i];
     // generate documentation for dataset
  end;
    
finally
  daservice.Free;
end;  

• write your documentation into aResponseStream.

Note: you don’t need to use 1st and 2nd steps from above snippet.

[tstoicescu]

I wil try!
Thanks