This is an exemplary Web Service which demonstrates ApodiniAudit. ApodiniAudit is a tool to provide feedback on the quality of RESTful APIs built in Apodini.
When auditing a Web Service using ApodiniAudit, Python & NLTK are used to perform linguistic analysis. Thus, we need to install them before running an audit. This is done automatically when running the tests.
A Python 3 installation is required. Once Python is installed, NLTK and its dependencies can be installed as follows:
$ swift run ImprovedLinguaWebService audit setup-nltk
You can run the Improved Web Service using the following command:
$ swift run ImprovedLinguaWebService
To run the tests which validate the audits, the report format, and the enforcable best practices, run the following command:
$ swift test
Alternatively, the tests can be run on various platforms by manually starting the "Build & Test" workflow.
This project is licensed under the MIT License. See Licenses for more information.