FarmStall API
 v1 
OAS3

openapi.yaml

An API for writing reviews about your favourite (or worst) farm stalls.

Picture of produce


Auth

To create Reviews without being anonymous. You need to add a MyUserToken to the Authorization header.

To get a MyUserToken:

  1. Create a User with POST /users
  2. Get a MyUserToken by calling POST /tokens with your User credentials.

Reviews

Reviews are the heart of this API.
Registered Users and anonymous users can both write reviews based on their experience at farm stalls.

Each review comes with a rating of between one and five stars inclusive.

  • One star being the worst experience
  • Five stars being the best

Example Reviews

"A wonderful time!" — Bob McNally
5 stars

"An awful place" — Anonymous
1 star

"A totally average place." — Jane Fair
3 stars

SwaggerHub
Servers

Reviews

Reviews of your favourite/worst farm stalls

Users

Users and authentication