LGglenn/trefle_api

Trefle api documentation

Getting Started Guide

How to launch locally the api:

add .env like the .env.exemple yarn install yarn dev

Part1

url for api run locally : "http://localhost:8888/api/part1"

GET : /api/part1

parameters : {
family_common_name: string required
}

return : { "message":"success", "data":[ {"scientific_name":string,"year":number}, {"scientific_name":"string,"year":number} ] }

Part2

url for api run locally : "http://localhost:8888/api/part2"

GET : /api/part2

parameters : {
    family_common_name: string required
}

return : { "message":"success", "data":[ { "scientific_name":string, "year":number, "genus_family_common_name":string, "species_observation":string, }, ... ] }