Wrap the common components in every API response using ASP.NET CORE 2 Middleware











up vote
0
down vote

favorite












I have the following POCO classes :



public class CountryResult : APIResult
{
public CountryResult()
{
Countries = new List<CountryDTO>();
}

public List<CountryDTO> Countries
{
get;
set;
}
}

public class APIResult
{
public Locale Locale
{
get;
set;
}

[JsonProperty("authorised")]
public bool Authorized
{
get;
set;
}

public string UserMessage
{
get;
set;
}

= "";
}


The json response should always to be consistent. The locale, authorised,userMessage are common in every payload response.



{
"countries": ,
"locale": {
"localisationIdentifier": "en",
"enabled": true,
"language": "en",
"country": "",
"description": "English",
"uuid": "37",
"name": "English",
"path": "/locales/en",
"rightToLeft": false,
"completeResponse": true,
"scriptDirection": "ltr"
},
"authorised": false,
"userMessage": ""
}


I developed a CommonResponseMiddleware (Middlware component) in order to implement this requirement.



public class CommonResponseMiddleware
{
private readonly RequestDelegate _next;
private ICommonService _commonService;
public CommonResponseMiddleware(RequestDelegate next, ICommonService commonService)
{
_next = next;
_commonService = commonService;
}

public async Task Invoke(HttpContext context)
{
var currentBody = context.Response.Body;
using (var memoryStream = new MemoryStream())
{
context.Response.Body = memoryStream;
// Hit the web api and get the result
await _next.Invoke(context);
context.Response.Body = currentBody;
memoryStream.Seek(0, SeekOrigin.Begin);
var readToEnd = new StreamReader(memoryStream).ReadToEnd();
var objResult = JsonConvert.DeserializeObject(readToEnd);
}
}
}


In the objResult I get the all the data for Entity: CountryResult but with all the properties of APIResult(locale, authorised,userMessage) still set to null.



How to setup the values of APIResult and return it as part of the complete payload?



Can anyone help me here to fix this issue by providing their guidance?










share|improve this question






















  • Getting stuck through some errors to get it half-working, but was wondering if we could get an example with some code sample on this issue. I have been trying a lot but nothing working. Any help is much appreciated.
    – santosh kumar patro
    Nov 11 at 15:20















up vote
0
down vote

favorite












I have the following POCO classes :



public class CountryResult : APIResult
{
public CountryResult()
{
Countries = new List<CountryDTO>();
}

public List<CountryDTO> Countries
{
get;
set;
}
}

public class APIResult
{
public Locale Locale
{
get;
set;
}

[JsonProperty("authorised")]
public bool Authorized
{
get;
set;
}

public string UserMessage
{
get;
set;
}

= "";
}


The json response should always to be consistent. The locale, authorised,userMessage are common in every payload response.



{
"countries": ,
"locale": {
"localisationIdentifier": "en",
"enabled": true,
"language": "en",
"country": "",
"description": "English",
"uuid": "37",
"name": "English",
"path": "/locales/en",
"rightToLeft": false,
"completeResponse": true,
"scriptDirection": "ltr"
},
"authorised": false,
"userMessage": ""
}


I developed a CommonResponseMiddleware (Middlware component) in order to implement this requirement.



public class CommonResponseMiddleware
{
private readonly RequestDelegate _next;
private ICommonService _commonService;
public CommonResponseMiddleware(RequestDelegate next, ICommonService commonService)
{
_next = next;
_commonService = commonService;
}

public async Task Invoke(HttpContext context)
{
var currentBody = context.Response.Body;
using (var memoryStream = new MemoryStream())
{
context.Response.Body = memoryStream;
// Hit the web api and get the result
await _next.Invoke(context);
context.Response.Body = currentBody;
memoryStream.Seek(0, SeekOrigin.Begin);
var readToEnd = new StreamReader(memoryStream).ReadToEnd();
var objResult = JsonConvert.DeserializeObject(readToEnd);
}
}
}


In the objResult I get the all the data for Entity: CountryResult but with all the properties of APIResult(locale, authorised,userMessage) still set to null.



How to setup the values of APIResult and return it as part of the complete payload?



Can anyone help me here to fix this issue by providing their guidance?










share|improve this question






















  • Getting stuck through some errors to get it half-working, but was wondering if we could get an example with some code sample on this issue. I have been trying a lot but nothing working. Any help is much appreciated.
    – santosh kumar patro
    Nov 11 at 15:20













up vote
0
down vote

favorite









up vote
0
down vote

favorite











I have the following POCO classes :



public class CountryResult : APIResult
{
public CountryResult()
{
Countries = new List<CountryDTO>();
}

public List<CountryDTO> Countries
{
get;
set;
}
}

public class APIResult
{
public Locale Locale
{
get;
set;
}

[JsonProperty("authorised")]
public bool Authorized
{
get;
set;
}

public string UserMessage
{
get;
set;
}

= "";
}


The json response should always to be consistent. The locale, authorised,userMessage are common in every payload response.



{
"countries": ,
"locale": {
"localisationIdentifier": "en",
"enabled": true,
"language": "en",
"country": "",
"description": "English",
"uuid": "37",
"name": "English",
"path": "/locales/en",
"rightToLeft": false,
"completeResponse": true,
"scriptDirection": "ltr"
},
"authorised": false,
"userMessage": ""
}


I developed a CommonResponseMiddleware (Middlware component) in order to implement this requirement.



public class CommonResponseMiddleware
{
private readonly RequestDelegate _next;
private ICommonService _commonService;
public CommonResponseMiddleware(RequestDelegate next, ICommonService commonService)
{
_next = next;
_commonService = commonService;
}

public async Task Invoke(HttpContext context)
{
var currentBody = context.Response.Body;
using (var memoryStream = new MemoryStream())
{
context.Response.Body = memoryStream;
// Hit the web api and get the result
await _next.Invoke(context);
context.Response.Body = currentBody;
memoryStream.Seek(0, SeekOrigin.Begin);
var readToEnd = new StreamReader(memoryStream).ReadToEnd();
var objResult = JsonConvert.DeserializeObject(readToEnd);
}
}
}


In the objResult I get the all the data for Entity: CountryResult but with all the properties of APIResult(locale, authorised,userMessage) still set to null.



How to setup the values of APIResult and return it as part of the complete payload?



Can anyone help me here to fix this issue by providing their guidance?










share|improve this question













I have the following POCO classes :



public class CountryResult : APIResult
{
public CountryResult()
{
Countries = new List<CountryDTO>();
}

public List<CountryDTO> Countries
{
get;
set;
}
}

public class APIResult
{
public Locale Locale
{
get;
set;
}

[JsonProperty("authorised")]
public bool Authorized
{
get;
set;
}

public string UserMessage
{
get;
set;
}

= "";
}


The json response should always to be consistent. The locale, authorised,userMessage are common in every payload response.



{
"countries": ,
"locale": {
"localisationIdentifier": "en",
"enabled": true,
"language": "en",
"country": "",
"description": "English",
"uuid": "37",
"name": "English",
"path": "/locales/en",
"rightToLeft": false,
"completeResponse": true,
"scriptDirection": "ltr"
},
"authorised": false,
"userMessage": ""
}


I developed a CommonResponseMiddleware (Middlware component) in order to implement this requirement.



public class CommonResponseMiddleware
{
private readonly RequestDelegate _next;
private ICommonService _commonService;
public CommonResponseMiddleware(RequestDelegate next, ICommonService commonService)
{
_next = next;
_commonService = commonService;
}

public async Task Invoke(HttpContext context)
{
var currentBody = context.Response.Body;
using (var memoryStream = new MemoryStream())
{
context.Response.Body = memoryStream;
// Hit the web api and get the result
await _next.Invoke(context);
context.Response.Body = currentBody;
memoryStream.Seek(0, SeekOrigin.Begin);
var readToEnd = new StreamReader(memoryStream).ReadToEnd();
var objResult = JsonConvert.DeserializeObject(readToEnd);
}
}
}


In the objResult I get the all the data for Entity: CountryResult but with all the properties of APIResult(locale, authorised,userMessage) still set to null.



How to setup the values of APIResult and return it as part of the complete payload?



Can anyone help me here to fix this issue by providing their guidance?







c# asp.net-core-2.0






share|improve this question













share|improve this question











share|improve this question




share|improve this question










asked Nov 10 at 20:11









santosh kumar patro

1,77282654




1,77282654












  • Getting stuck through some errors to get it half-working, but was wondering if we could get an example with some code sample on this issue. I have been trying a lot but nothing working. Any help is much appreciated.
    – santosh kumar patro
    Nov 11 at 15:20


















  • Getting stuck through some errors to get it half-working, but was wondering if we could get an example with some code sample on this issue. I have been trying a lot but nothing working. Any help is much appreciated.
    – santosh kumar patro
    Nov 11 at 15:20
















Getting stuck through some errors to get it half-working, but was wondering if we could get an example with some code sample on this issue. I have been trying a lot but nothing working. Any help is much appreciated.
– santosh kumar patro
Nov 11 at 15:20




Getting stuck through some errors to get it half-working, but was wondering if we could get an example with some code sample on this issue. I have been trying a lot but nothing working. Any help is much appreciated.
– santosh kumar patro
Nov 11 at 15:20

















active

oldest

votes











Your Answer






StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");

StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});

function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});


}
});














 

draft saved


draft discarded


















StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53242996%2fwrap-the-common-components-in-every-api-response-using-asp-net-core-2-middleware%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown






























active

oldest

votes













active

oldest

votes









active

oldest

votes






active

oldest

votes
















 

draft saved


draft discarded



















































 


draft saved


draft discarded














StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53242996%2fwrap-the-common-components-in-every-api-response-using-asp-net-core-2-middleware%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







Popular posts from this blog

Florida Star v. B. J. F.

Danny Elfman

Retrieve a Users Dashboard in Tumblr with R and TumblR. Oauth Issues