How to edit Flask-plus default swagger-UI text
up vote
2
down vote
favorite
I am developing a simple rest api that only has two Get methods so far. It's working fine etc, and looks pretty great when I navigate to the url thanks to the built in swagger documentation.
However I do not actually see a yaml or json file anywhere. How do I change the title and default values as shown in the screenshot? Hopefully it's possible without making a whole separate yaml or json doc?
I don't actually want to change the design at all. I only want to edit the text a little.
python rest flask swagger flask-restplus
asked Nov 10 at 8:47
sit_on_a_pan_otis
1677
add a comment |
up vote
2
down vote
favorite
I am developing a simple rest api that only has two Get methods so far. It's working fine etc, and looks pretty great when I navigate to the url thanks to the built in swagger documentation.
However I do not actually see a yaml or json file anywhere. How do I change the title and default values as shown in the screenshot? Hopefully it's possible without making a whole separate yaml or json doc?
I don't actually want to change the design at all. I only want to edit the text a little.
python rest flask swagger flask-restplus
asked Nov 10 at 8:47
sit_on_a_pan_otis
1677
add a comment |
up vote
2
down vote
favorite
up vote
2
down vote
favorite
I am developing a simple rest api that only has two Get methods so far. It's working fine etc, and looks pretty great when I navigate to the url thanks to the built in swagger documentation.
However I do not actually see a yaml or json file anywhere. How do I change the title and default values as shown in the screenshot? Hopefully it's possible without making a whole separate yaml or json doc?
I don't actually want to change the design at all. I only want to edit the text a little.
python rest flask swagger flask-restplus
asked Nov 10 at 8:47
sit_on_a_pan_otis
1677
I am developing a simple rest api that only has two Get methods so far. It's working fine etc, and looks pretty great when I navigate to the url thanks to the built in swagger documentation.
However I do not actually see a yaml or json file anywhere. How do I change the title and default values as shown in the screenshot? Hopefully it's possible without making a whole separate yaml or json doc?
I don't actually want to change the design at all. I only want to edit the text a little.
python rest flask swagger flask-restplus
python rest flask swagger flask-restplus
asked Nov 10 at 8:47
sit_on_a_pan_otis
1677
asked Nov 10 at 8:47
sit_on_a_pan_otis
1677
asked Nov 10 at 8:47
sit_on_a_pan_otis
1677
asked Nov 10 at 8:47
sit_on_a_pan_otis
1677
asked Nov 10 at 8:47
sit_on_a_pan_otis
1677
1677
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
up vote
1
down vote
accepted
You set the title when creating the API:
api = Api(app, version='1.0', title='Your API Name',
description='A more complete description')
You set the namespace to something other than default by creating a namespace:
ns = api.namespace('not-default',
description='Whatever your namespace is')
Then you create your routes in the appropriate namespace:
@ns.route(...)
This is a handy way to group your APIs. See the Full Example for help if needed.
answered Nov 10 at 15:02
dmulter
1,0633717
To add on to that... your answer prompted me to this bug tracker: github.com/noirbizarre/flask-restplus/issues/460 . Thanks for your answer
– sit_on_a_pan_otis
Nov 10 at 17:44
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
Nov 10 at 17:51
add a comment |
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
});
}
});
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%2f53237385%2fhow-to-edit-flask-plus-default-swagger-ui-text%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
up vote
1
down vote
accepted
You set the title when creating the API:
api = Api(app, version='1.0', title='Your API Name',
description='A more complete description')
You set the namespace to something other than default by creating a namespace:
ns = api.namespace('not-default',
description='Whatever your namespace is')
Then you create your routes in the appropriate namespace:
@ns.route(...)
This is a handy way to group your APIs. See the Full Example for help if needed.
answered Nov 10 at 15:02
dmulter
1,0633717
To add on to that... your answer prompted me to this bug tracker: github.com/noirbizarre/flask-restplus/issues/460 . Thanks for your answer
– sit_on_a_pan_otis
Nov 10 at 17:44
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
Nov 10 at 17:51
add a comment |
up vote
1
down vote
accepted
You set the title when creating the API:
api = Api(app, version='1.0', title='Your API Name',
description='A more complete description')
You set the namespace to something other than default by creating a namespace:
ns = api.namespace('not-default',
description='Whatever your namespace is')
Then you create your routes in the appropriate namespace:
@ns.route(...)
This is a handy way to group your APIs. See the Full Example for help if needed.
answered Nov 10 at 15:02
dmulter
1,0633717
To add on to that... your answer prompted me to this bug tracker: github.com/noirbizarre/flask-restplus/issues/460 . Thanks for your answer
– sit_on_a_pan_otis
Nov 10 at 17:44
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
Nov 10 at 17:51
add a comment |
up vote
1
down vote
accepted
up vote
1
down vote
accepted
You set the title when creating the API:
api = Api(app, version='1.0', title='Your API Name',
description='A more complete description')
You set the namespace to something other than default by creating a namespace:
ns = api.namespace('not-default',
description='Whatever your namespace is')
Then you create your routes in the appropriate namespace:
@ns.route(...)
This is a handy way to group your APIs. See the Full Example for help if needed.
answered Nov 10 at 15:02
dmulter
1,0633717
You set the title when creating the API:
api = Api(app, version='1.0', title='Your API Name',
description='A more complete description')
You set the namespace to something other than default by creating a namespace:
ns = api.namespace('not-default',
description='Whatever your namespace is')
Then you create your routes in the appropriate namespace:
@ns.route(...)
This is a handy way to group your APIs. See the Full Example for help if needed.
answered Nov 10 at 15:02
dmulter
1,0633717
answered Nov 10 at 15:02
dmulter
1,0633717
answered Nov 10 at 15:02
dmulter
1,0633717
answered Nov 10 at 15:02
dmulter
1,0633717
1,0633717
To add on to that... your answer prompted me to this bug tracker: github.com/noirbizarre/flask-restplus/issues/460 . Thanks for your answer
– sit_on_a_pan_otis
Nov 10 at 17:44
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
Nov 10 at 17:51
add a comment |
To add on to that... your answer prompted me to this bug tracker: github.com/noirbizarre/flask-restplus/issues/460 . Thanks for your answer
– sit_on_a_pan_otis
Nov 10 at 17:44
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
Nov 10 at 17:51
To add on to that... your answer prompted me to this bug tracker: github.com/noirbizarre/flask-restplus/issues/460 . Thanks for your answer
– sit_on_a_pan_otis
Nov 10 at 17:44
To add on to that... your answer prompted me to this bug tracker: github.com/noirbizarre/flask-restplus/issues/460 . Thanks for your answer
– sit_on_a_pan_otis
Nov 10 at 17:44
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
Nov 10 at 17:51
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
Nov 10 at 17:51
add a comment |
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%2f53237385%2fhow-to-edit-flask-plus-default-swagger-ui-text%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
