API Routing with a custom header request value c#
I am doing a service upgrade to our whole back end package to include an addition to the responses that are across the board.
This affects the back-end service as well as any custom client applications of the service. So the idea is to not make it break what exists when it gets deployed.
As a result, I need to route two different API calls without modifying the URL call.
The idea is to create a custom Header as part of the request with a true/false value.
So an example API call is this route "{base}/{source}/person/id"
this returns a base person object.
however, the new requirement is to return that person object, with an added message list inside a new object.
So from this
return person
to
return genericObjectWithMessages
where the genericObjectWithMessages contains attributes of list and the person object side by side.
is this possible?
[Route("{ID}")]
[HttpGet]
[HttpHeadAttribute("retrievemessages")=false]
public async Task<Person> RetrieveEntity(string id, string source)
{
return Person;
}
[Route("{ID}")]
[HttpGet]
[HttpHeadAttribute("retrievemessages")=true]
public async Task<genericObjectWithMessages> RetrieveEntity(string id, string source)
{
return genericObjectWithMessages
}
public GenericObjectWithMessages
{
Person aPerson {get;set;}
List<message> messages {get;set;}
}
P.S. This is an asked requirement based on different versions and the like but API versioning is not implemented.
c# asp.net routes
edited Nov 21 at 6:48
Adam
65521022
asked Nov 21 at 4:43
Tim Willson
11
add a comment |
I am doing a service upgrade to our whole back end package to include an addition to the responses that are across the board.
This affects the back-end service as well as any custom client applications of the service. So the idea is to not make it break what exists when it gets deployed.
As a result, I need to route two different API calls without modifying the URL call.
The idea is to create a custom Header as part of the request with a true/false value.
So an example API call is this route "{base}/{source}/person/id"
this returns a base person object.
however, the new requirement is to return that person object, with an added message list inside a new object.
So from this
return person
to
return genericObjectWithMessages
where the genericObjectWithMessages contains attributes of list and the person object side by side.
is this possible?
[Route("{ID}")]
[HttpGet]
[HttpHeadAttribute("retrievemessages")=false]
public async Task<Person> RetrieveEntity(string id, string source)
{
return Person;
}
[Route("{ID}")]
[HttpGet]
[HttpHeadAttribute("retrievemessages")=true]
public async Task<genericObjectWithMessages> RetrieveEntity(string id, string source)
{
return genericObjectWithMessages
}
public GenericObjectWithMessages
{
Person aPerson {get;set;}
List<message> messages {get;set;}
}
P.S. This is an asked requirement based on different versions and the like but API versioning is not implemented.
c# asp.net routes
edited Nov 21 at 6:48
Adam
65521022
asked Nov 21 at 4:43
Tim Willson
11
what is the question?
– miechooy
Nov 21 at 7:38
add a comment |
I am doing a service upgrade to our whole back end package to include an addition to the responses that are across the board.
This affects the back-end service as well as any custom client applications of the service. So the idea is to not make it break what exists when it gets deployed.
As a result, I need to route two different API calls without modifying the URL call.
The idea is to create a custom Header as part of the request with a true/false value.
So an example API call is this route "{base}/{source}/person/id"
this returns a base person object.
however, the new requirement is to return that person object, with an added message list inside a new object.
So from this
return person
to
return genericObjectWithMessages
where the genericObjectWithMessages contains attributes of list and the person object side by side.
is this possible?
[Route("{ID}")]
[HttpGet]
[HttpHeadAttribute("retrievemessages")=false]
public async Task<Person> RetrieveEntity(string id, string source)
{
return Person;
}
[Route("{ID}")]
[HttpGet]
[HttpHeadAttribute("retrievemessages")=true]
public async Task<genericObjectWithMessages> RetrieveEntity(string id, string source)
{
return genericObjectWithMessages
}
public GenericObjectWithMessages
{
Person aPerson {get;set;}
List<message> messages {get;set;}
}
P.S. This is an asked requirement based on different versions and the like but API versioning is not implemented.
c# asp.net routes
edited Nov 21 at 6:48
Adam
65521022
asked Nov 21 at 4:43
Tim Willson
11
I am doing a service upgrade to our whole back end package to include an addition to the responses that are across the board.
This affects the back-end service as well as any custom client applications of the service. So the idea is to not make it break what exists when it gets deployed.
As a result, I need to route two different API calls without modifying the URL call.
The idea is to create a custom Header as part of the request with a true/false value.
So an example API call is this route "{base}/{source}/person/id"
this returns a base person object.
however, the new requirement is to return that person object, with an added message list inside a new object.
So from this
return person
to
return genericObjectWithMessages
where the genericObjectWithMessages contains attributes of list and the person object side by side.
is this possible?
[Route("{ID}")]
[HttpGet]
[HttpHeadAttribute("retrievemessages")=false]
public async Task<Person> RetrieveEntity(string id, string source)
{
return Person;
}
[Route("{ID}")]
[HttpGet]
[HttpHeadAttribute("retrievemessages")=true]
public async Task<genericObjectWithMessages> RetrieveEntity(string id, string source)
{
return genericObjectWithMessages
}
public GenericObjectWithMessages
{
Person aPerson {get;set;}
List<message> messages {get;set;}
}
P.S. This is an asked requirement based on different versions and the like but API versioning is not implemented.
c# asp.net routes
c# asp.net routes
edited Nov 21 at 6:48
Adam
65521022
asked Nov 21 at 4:43
Tim Willson
11
edited Nov 21 at 6:48
Adam
65521022
asked Nov 21 at 4:43
Tim Willson
11
edited Nov 21 at 6:48
Adam
65521022
edited Nov 21 at 6:48
Adam
65521022
edited Nov 21 at 6:48
Adam
65521022
65521022
asked Nov 21 at 4:43
Tim Willson
11
asked Nov 21 at 4:43
Tim Willson
11
asked Nov 21 at 4:43
Tim Willson
11
11
what is the question?
– miechooy
Nov 21 at 7:38
add a comment |
what is the question?
– miechooy
Nov 21 at 7:38
what is the question?
– miechooy
Nov 21 at 7:38
what is the question?
– miechooy
Nov 21 at 7:38
add a comment |
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',
autoActivateHeartbeat: false,
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
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53405389%2fapi-routing-with-a-custom-header-request-value-c-sharp%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
active
oldest
votes
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Some of your past answers have not been well-received, and you're in danger of being blocked from answering.
Please pay close attention to the following guidance:
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53405389%2fapi-routing-with-a-custom-header-request-value-c-sharp%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
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
what is the question?
– miechooy
Nov 21 at 7:38