OpenAPI documentation when result is TJsonObject

[Mika_Koistinen]

Hi,
In some (rare) cases we would like to provide TJsonObject as result. For example when using TDatasnapJsonSerializer. is it possibile to provide manual declaration of result for openapi description.

[wlandgraf (Wagner Landgraf)]

It is "possible", but not trivial.
You can use the approach described here to hook a code that is executed right after a Swagger document is generated:

Swagger customisation

Hi @Weetch_Russell, yes, it's possible. It's not trivial, but here is the code. First, you create a class implementing IOpenApiEvents: uses System.StrUtils, XData.OpenApi.Service.Internal, OpenApi.Classes.Path, OpenApi.Document, OpenApi.Classes.Operation, Bcl.Json.Converters, XData.Model.Classes, type TMyOpenApiEvents = class(TInterfacedObject, IOpenApiEvents) public procedure DocumentCreated(Document: TOpenApiDocument); procedure GetDefinitionName(var DefinitionName: string; T…

Once you do that, you can modify the document as you wish. You would have to manually find the path/url you want to modify and set all the classes accordingly to describe the resulting object.