A publicly available web-based API that returns data about Restaurants based a user requests.
| User Story | Input | Output | |
|---|---|---|---|
| As a user, I want to see all Restaurants in a specific zip code | |||
| As a user, I want to see one individual Restaurant | |||
| As a user, I want to see a specific information such as the Restaurant's name, address, phone number, website, and email | |||
| As a user, I want to see which kind of Foodtypes a single Restaurant is associated with | |||
| As a user, I want to see all Restaurants of a specific Foodtype (say, Pho, or Brunch) so I can browse through them | |||
| As a user, I want to be able to leave a Review of a Restaurant | |||
| As a user, I want to see the average rating for a Restaurant | |||
| As a user, I want to see all Reviews for a Restaurant | |||
| As an admin, I want to be able to add a Restaurant to the database | |||
| As an admin, I want to delete Restaurants that close. | |||
| As an admin, I want to edit Restaurants where details change | |||
| As an admin, I want to delete Reviews that are from trolls and spammers | |||
| As an admin, I want to add a Foodtype so a Restaurant can be associated with it |
- Download or fork and then clone down from Here
- Install or use an IDEA program. IntelliJ Recommended.
- Open project folder in IDEA and run App.
- Use Postman to Post and Get Data to query through API to and from database
None Known.
Contact can be made promptly through one of our now many means of communication. Please email @ rtbfletch at outlook.
- Java and Junit testing
- IntelliJ
- Spark Routes
- Git and Github for version control
Copyright (c) 2018 Ross Fletcher
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.