NsWag generated code for c# dose not match with response dto object

[Rgl88]

I use blow code for get token in winform:

var tokenService = new Services.WebApi.TokenAuthClient("http://localhost:21021");
var result = await tokenService.AuthenticateAsync(new Services.WebApi.AuthenticateModel()
{
    UserNameOrEmailAddress = "admin",
    Password = "123qwe",
    RememberClient = true
});

The service class generated via Nswag.
but problem where blow method want deserialize json response to AuthenticateResultModel and it not work.

public async System.Threading.Tasks.Task<AuthenticateResultModel> AuthenticateAsync(AuthenticateModel model, System.Threading.CancellationToken cancellationToken)
{
...
      result_ = Newtonsoft.Json.JsonConvert.DeserializeObject<AuthenticateResultModel>(responseData_ , _settings.Value);
....
}

deserializer not work because response template do not match with AuthenticateResultModel
Response:

{
    "result":
    {
    "accessToken":"5",
    "encryptedAccessToken":"6",
    "expireInSeconds":86400,
    "userId":2
    },
"targetUrl":null,
"success":true,
"error":null,
"unAuthorizedRequest":false,
"__abp":true
}

But AuthenticateResultModel:

[System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "9.6.5.0 (Newtonsoft.Json v9.0.0.0)")]
public partial class AuthenticateResultModel 
{
    [Newtonsoft.Json.JsonProperty("accessToken", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public string AccessToken { get; set; }
    
    [Newtonsoft.Json.JsonProperty("encryptedAccessToken", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public string EncryptedAccessToken { get; set; }
    
    [Newtonsoft.Json.JsonProperty("expireInSeconds", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public int? ExpireInSeconds { get; set; }
    
    [Newtonsoft.Json.JsonProperty("userId", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
    public long? UserId { get; set; }
    
    public string ToJson() 
    {
        return Newtonsoft.Json.JsonConvert.SerializeObject(this);
    }
        
    public static AuthenticateResultModel FromJson(string data)
    {
        return Newtonsoft.Json.JsonConvert.DeserializeObject<AuthenticateResultModel>(data);
    }
}

I test with new model class and it work how configure Nswag or Abp to generate correct code?

public class AuthenticateResultModel
{
    public AuthenticateResultModel Result{ get; set; }
    public string TargetUrl { get; set; }
    public bool Success { get; set; }
    public string Error { get; set; }
    public bool UnAuthorizedRequest { get; set; }
    public bool __abp { get; set; }
}

public class AuthenticateResultModel
{
    public string AccessToken { get; set; }
    public string EncryptedAccessToken { get; set; }
    public int? ExpireInSeconds { get; set; }
    public long? UserId { get; set; }
}

[ismcagdas]

@Rgl88, ABP wraps result with AjaxResponse. I think NSwag cannot understand this. Maybe you can use a class for NSwag to get only Result field of returned response. Have you checked on NSwag's repo if this is possible ?

[Rgl88]

@ismcagdas as for response from Nswag owner, i can add attribute to controller methods, but in abp controllers generated dynamicly (Application Services as Controllers).
How i can add this attribute to controller methods? Of course, there is another solution (implement a custom OperationProcessor ...)

Attribute for controller methods
[SwaggerResponse(200, typeof(MyResponse)]

public class MyResponse<T>
{
    public T Result { get; set; }
    public string TargetUrl { get; set; }
    public bool Success { get; set; }
    public string Error { get; set; }
    public bool UnAuthorizedRequest { get; set; }
    public bool __abp { get; set; }
}

[hikalkan]

You can add that attribute to application service classes (not interfaces) and it should work. Surely, you need to add a reference to swagger in that case, but there is no other way.

[Rgl88]

It is very hard to add this attribute to all methods and for AsyncCrudAppService must all methods overrided,
I go implement custom OperationProcessor for NSwag.
I test it but Nswag do not understand it:

[SwaggerResponse(200, typeof(Response))]
public override Task<PagedResultDto<BankDto>> GetAll(PagedResultRequestDto input)
{
      return base.GetAll(input);
}

public class Response
{
     public PagedResultDto<BankDto> Result { get; set; }
     public string TargetUrl { get; set; }
     public bool Success { get; set; }
     public string Error { get; set; }
     public bool UnAuthorizedRequest { get; set; }
     public bool __abp { get; set; }
}

[Rgl88]

Very simple solution:

var str = File.ReadAllText(filePath);

var methodReturnPattern = @"System.Threading.Tasks.Task<(?'TypeName'\w+){1}\>+";

var deserializerPattern = @"result_ = Newtonsoft.Json.JsonConvert.DeserializeObject<(?'TypeName'\w+){1}\>{1}";

var resultDefinitionPattern = @"default\((?'TypeName'\w+){1}\);{1}";

var baseUrlPattern = @"(?'VarName'urlBuilder_)\.Append";

var result = Regex.Replace(str, methodReturnPattern, m => m.Value.Replace(m.Groups["TypeName"].Value, "Response<"+m.Groups["TypeName"].Value + ">"));
result = Regex.Replace(result, deserializerPattern, m => m.Value.Replace(m.Groups["TypeName"].Value, "Response<" + m.Groups["TypeName"].Value + ">"));
result = Regex.Replace(result, resultDefinitionPattern, m => m.Value.Replace(m.Groups["TypeName"].Value, "Response<" + m.Groups["TypeName"].Value + ">"));
result = Regex.Replace(result, baseUrlPattern, m => m.Value.Replace(m.Groups["VarName"].Value, m.Groups["VarName"].Value + ".Append(BaseUrl)"));
File.WriteAllText(filePath, result);

[jogoertzen-stantec]

@ismcagdas as for response from Nswag owner, i can add attribute to controller methods, but in abp controllers generated dynamicly (Application Services as Controllers).
How i can add this attribute to controller methods? Of course, there is another solution (implement a custom OperationProcessor ...)

Attribute for controller methods
[SwaggerResponse(200, typeof(MyResponse)]

public class MyResponse<T>
{
    public T Result { get; set; }
    public string TargetUrl { get; set; }
    public bool Success { get; set; }
    public string Error { get; set; }
    public bool UnAuthorizedRequest { get; set; }
    public bool __abp { get; set; }
}

This worked for me, but I used

[ProducesResponseType(typeof(MyResponse<...>), 200)]

instead of

[SwaggerResponse(200, typeof(MyResponse<...>)]

as per this