Add API documentation - Githubissues

gabrielpreda / Support-Tickets-Classification

This case study shows how to create a model for text analysis and classification and deploy it as a web service in Azure cloud in order to automatically classify support tickets. This project is a proof of concept made by Microsoft (Commercial Software Engineering team) in collaboration with Endava http://endava.com/en

MIT License

3 stars 6 forks source link

Add API documentation #2

Open gabrielpreda opened 5 years ago

gabrielpreda commented 5 years ago

Add API documentation Current implementation is using Flask and Python to create a web API

Acceptance criteria:

all functions exposed should have documentation
examples for use of each function should be provided

Note: Flask, Swagger UI and Flask-RESTPlus could be used to create a basic documentation of the existing API; here is an example: http://michal.karzynski.pl/blog/2016/06/19/building-beautiful-restful-apis-using-flask-swagger-ui-flask-restplus/