Interceptor response modification with swagger documentation
I'm not sure whether this question specific for Nest.js or any of backend framework, but anyway.
I'm having route which returns some object of class A. Now I need add logic to this route which checks if specific query parameter is set, and if so transform response completely and return object of class B.
I need to have such interceptors on several routes with small modifications, and not intercepted response values might vary. This data structures might look like so.
class A {}
class B { values: A }
OriginalResponse1 -> A
OriginalResponse2 -> A
OriginalResponse3 -> B
OriginalResponse4 -> B
InterceptedResponse1 -> { value, [A], , }
InterceptedResponse2 -> { value, A[1:3], A[3:5], }
InterceptedResponse3 -> { value, , [B], [B.A[1:2]] }
InterceptedResponse4 -> { value, , [B[1]], B[1:].A }
Two questions here:
- Is it even correct to do such things in interceptor? Shall I move into separate routes instead?
- How can does it usually documented in swagger then? Particularly I'm interested in how to do this in Nest.js
If the first question is negative (it is incorrect and I shouldn't do it like that), then no answer on question number two can be omitted. Thanks!
rest swagger backend interceptor nestjs
asked Nov 14 '18 at 20:46
QuestionAndAnswerQuestionAndAnswer
1,41511327
add a comment |
I'm not sure whether this question specific for Nest.js or any of backend framework, but anyway.
I'm having route which returns some object of class A. Now I need add logic to this route which checks if specific query parameter is set, and if so transform response completely and return object of class B.
I need to have such interceptors on several routes with small modifications, and not intercepted response values might vary. This data structures might look like so.
class A {}
class B { values: A }
OriginalResponse1 -> A
OriginalResponse2 -> A
OriginalResponse3 -> B
OriginalResponse4 -> B
InterceptedResponse1 -> { value, [A], , }
InterceptedResponse2 -> { value, A[1:3], A[3:5], }
InterceptedResponse3 -> { value, , [B], [B.A[1:2]] }
InterceptedResponse4 -> { value, , [B[1]], B[1:].A }
Two questions here:
- Is it even correct to do such things in interceptor? Shall I move into separate routes instead?
- How can does it usually documented in swagger then? Particularly I'm interested in how to do this in Nest.js
If the first question is negative (it is incorrect and I shouldn't do it like that), then no answer on question number two can be omitted. Thanks!
rest swagger backend interceptor nestjs
asked Nov 14 '18 at 20:46
QuestionAndAnswerQuestionAndAnswer
1,41511327
add a comment |
I'm not sure whether this question specific for Nest.js or any of backend framework, but anyway.
I'm having route which returns some object of class A. Now I need add logic to this route which checks if specific query parameter is set, and if so transform response completely and return object of class B.
I need to have such interceptors on several routes with small modifications, and not intercepted response values might vary. This data structures might look like so.
class A {}
class B { values: A }
OriginalResponse1 -> A
OriginalResponse2 -> A
OriginalResponse3 -> B
OriginalResponse4 -> B
InterceptedResponse1 -> { value, [A], , }
InterceptedResponse2 -> { value, A[1:3], A[3:5], }
InterceptedResponse3 -> { value, , [B], [B.A[1:2]] }
InterceptedResponse4 -> { value, , [B[1]], B[1:].A }
Two questions here:
- Is it even correct to do such things in interceptor? Shall I move into separate routes instead?
- How can does it usually documented in swagger then? Particularly I'm interested in how to do this in Nest.js
If the first question is negative (it is incorrect and I shouldn't do it like that), then no answer on question number two can be omitted. Thanks!
rest swagger backend interceptor nestjs
asked Nov 14 '18 at 20:46
QuestionAndAnswerQuestionAndAnswer
1,41511327
I'm not sure whether this question specific for Nest.js or any of backend framework, but anyway.
I'm having route which returns some object of class A. Now I need add logic to this route which checks if specific query parameter is set, and if so transform response completely and return object of class B.
I need to have such interceptors on several routes with small modifications, and not intercepted response values might vary. This data structures might look like so.
class A {}
class B { values: A }
OriginalResponse1 -> A
OriginalResponse2 -> A
OriginalResponse3 -> B
OriginalResponse4 -> B
InterceptedResponse1 -> { value, [A], , }
InterceptedResponse2 -> { value, A[1:3], A[3:5], }
InterceptedResponse3 -> { value, , [B], [B.A[1:2]] }
InterceptedResponse4 -> { value, , [B[1]], B[1:].A }
Two questions here:
- Is it even correct to do such things in interceptor? Shall I move into separate routes instead?
- How can does it usually documented in swagger then? Particularly I'm interested in how to do this in Nest.js
If the first question is negative (it is incorrect and I shouldn't do it like that), then no answer on question number two can be omitted. Thanks!
rest swagger backend interceptor nestjs
rest swagger backend interceptor nestjs
asked Nov 14 '18 at 20:46
QuestionAndAnswerQuestionAndAnswer
1,41511327
asked Nov 14 '18 at 20:46
QuestionAndAnswerQuestionAndAnswer
1,41511327
edited Nov 14 '18 at 20:55
QuestionAndAnswer
asked Nov 14 '18 at 20:46
QuestionAndAnswerQuestionAndAnswer
1,41511327
asked Nov 14 '18 at 20:46
QuestionAndAnswerQuestionAndAnswer
1,41511327
asked Nov 14 '18 at 20:46
QuestionAndAnswerQuestionAndAnswer
1,41511327
1,41511327
add a comment |
add a comment |
0
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%2f53308467%2finterceptor-response-modification-with-swagger-documentation%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
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.
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%2f53308467%2finterceptor-response-modification-with-swagger-documentation%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
