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 yesterday
sit_on_a_pan_otis
977
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 yesterday
sit_on_a_pan_otis
977
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 yesterday
sit_on_a_pan_otis
977
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 yesterday
sit_on_a_pan_otis
977
asked yesterday
sit_on_a_pan_otis
977
asked yesterday
sit_on_a_pan_otis
977
asked yesterday
sit_on_a_pan_otis
977
asked yesterday
sit_on_a_pan_otis
977
977
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 yesterday
dmulter
1,0173717
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
yesterday
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
yesterday
add a comment |
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 yesterday
dmulter
1,0173717
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
yesterday
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
yesterday
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 yesterday
dmulter
1,0173717
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
yesterday
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
yesterday
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 yesterday
dmulter
1,0173717
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 yesterday
dmulter
1,0173717
answered yesterday
dmulter
1,0173717
answered yesterday
dmulter
1,0173717
answered yesterday
dmulter
1,0173717
1,0173717
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
yesterday
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
yesterday
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
yesterday
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
yesterday
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
yesterday
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
yesterday
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
yesterday
I had to add api.namespaces.clear() before setting the ns variable. Works nicely!
– sit_on_a_pan_otis
yesterday
add a comment |
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
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
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
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
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
