noirbizarre
commented
9 years ago Hi !
Until now, I tried to stick to the upstream flask-restful which doesn't support this.
flask-restplus provides a workaround with the model kwarg for the @api.doc decorator:
from flask import Flask
from flask.ext.restplus import Api, Resource, fields
from nltk.tokenize import word_tokenize
import os, nltk
app = Flask(__name__)
api = Api(app, version='1.0', title='NLP Tools API',
description='A set of easy to use NLP tools powered by NLTK.',
)
ns = api.namespace('nlptools/api/v1', description='NLP operations')
parser = api.parser()
parser.add_argument('text', type=str, required=True, help='The text to be processed', location='json')
@ns.route('/tokenize')
@api.doc(responses={400: 'Invalid request'})
class Tokenizer(Resource):
@api.doc(parser=parser, description='Tokenizes the input text into a list of strings.')
@api.doc(model=[str])
def post(self):
args = parser.parse_args()
return word_tokenize(args['text'])
if __name__ == '__main__':
app.run(host=os.getenv('VCAP_APP_HOST', '127.0.0.1'), port=int(os.getenv('VCAP_APP_PORT', '5000')), debug=True)It should do the job. Just let me know if I can close the issue.
jpbufe3
I have a very simple method that is generating a list of strings and returning it. Currently the only way that the swagger docs will show the response type is if the method has @api.marshal_with() or @api.marshal_list_with(). However, neither of these methods seem to work appropriately with simple objects. Below is an example:
Running this with a REST client with a json body of {"text":"this is a test sentence to tokenize."} returns the following error:
I have also tried
return json.dumps(word_tokenize(args['text']))and@api.marshal_with(fields.List(fields.String))with the same result in all four cases. Is there an alternative way to represent the response object? Is there a way to appropriate marshal basic fields?Thanks.