How do a generate class property documentation from sources other than XML comments with Swagger in .net...
I'm using Swashbuckle and swagger for documenting model classes in my application. My class properties are currently documented using XML comments:
options.IncludeXmlComments(xmlCommentPath);
This is simple enough. I'm more interested in having these properties read from other sources besides XML documentation, like maybe another API, or a database table somewhere. Is this possible?
c# asp.net-core .net-core swagger swashbuckle
asked Nov 24 '18 at 23:49
TheTFoTheTFo
326416
add a comment |
I'm using Swashbuckle and swagger for documenting model classes in my application. My class properties are currently documented using XML comments:
options.IncludeXmlComments(xmlCommentPath);
This is simple enough. I'm more interested in having these properties read from other sources besides XML documentation, like maybe another API, or a database table somewhere. Is this possible?
c# asp.net-core .net-core swagger swashbuckle
asked Nov 24 '18 at 23:49
TheTFoTheTFo
326416
See this similar (possibly duplicate) question. your problem is solved the same way, using filters and annotations.
– Scott Chamberlain
Nov 24 '18 at 23:59
add a comment |
I'm using Swashbuckle and swagger for documenting model classes in my application. My class properties are currently documented using XML comments:
options.IncludeXmlComments(xmlCommentPath);
This is simple enough. I'm more interested in having these properties read from other sources besides XML documentation, like maybe another API, or a database table somewhere. Is this possible?
c# asp.net-core .net-core swagger swashbuckle
asked Nov 24 '18 at 23:49
TheTFoTheTFo
326416
I'm using Swashbuckle and swagger for documenting model classes in my application. My class properties are currently documented using XML comments:
options.IncludeXmlComments(xmlCommentPath);
This is simple enough. I'm more interested in having these properties read from other sources besides XML documentation, like maybe another API, or a database table somewhere. Is this possible?
c# asp.net-core .net-core swagger swashbuckle
c# asp.net-core .net-core swagger swashbuckle
asked Nov 24 '18 at 23:49
TheTFoTheTFo
326416
asked Nov 24 '18 at 23:49
TheTFoTheTFo
326416
asked Nov 24 '18 at 23:49
TheTFoTheTFo
326416
asked Nov 24 '18 at 23:49
TheTFoTheTFo
326416
asked Nov 24 '18 at 23:49
TheTFoTheTFo
326416
326416
See this similar (possibly duplicate) question. your problem is solved the same way, using filters and annotations.
– Scott Chamberlain
Nov 24 '18 at 23:59
add a comment |
See this similar (possibly duplicate) question. your problem is solved the same way, using filters and annotations.
– Scott Chamberlain
Nov 24 '18 at 23:59
See this similar (possibly duplicate) question. your problem is solved the same way, using filters and annotations.
– Scott Chamberlain
Nov 24 '18 at 23:59
See this similar (possibly duplicate) question. your problem is solved the same way, using filters and annotations.
– Scott Chamberlain
Nov 24 '18 at 23:59
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%2f53463435%2fhow-do-a-generate-class-property-documentation-from-sources-other-than-xml-comme%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%2f53463435%2fhow-do-a-generate-class-property-documentation-from-sources-other-than-xml-comme%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
See this similar (possibly duplicate) question. your problem is solved the same way, using filters and annotations.
– Scott Chamberlain
Nov 24 '18 at 23:59