Skip to content

Latest commit

 

History

History
116 lines (72 loc) · 2.45 KB

README.md

File metadata and controls

116 lines (72 loc) · 2.45 KB

RIMROCK API

"An API supporting Rimrock, a website that allows you to look up climbing locations and gear retailers."

Collaborative project, one week sprint.

Team Members:

Dan, Ben, Jason, Andrew

USER STORIES

GO TO FILE

DB SCHEMA

Note: Database schema is split between API and MVC

go to mvc git >>

DBSchema

ENDPOINTS AND DATA

For interactive Swagger documentation of API endpoints visit:

https://rimrockapi.azurewebsites.net/swagger

https://rimrockapi.azurewebsites.net/api/location/

Returns: List of class Location: List<Location>

    [
    {"id":1,"name":"Cliff Creek","cost":"$$$$$","regionID":1},
    {"id":2,"name":"Long Shore","cost":"$$","regionID":1},
    {"id":3,"name":"Peakies","cost":"$$$$","regionID":1},
    {"id":4,"name":"Big Rock","cost":"$$$","regionID":1},
    {"id":5,"name":"Little Rocks","cost":"$","regionID":1}
    ]
https://rimrockapi.azurewebsites.net/api/location/{id}

Returns: class Location by id prop: 

    {"id":1,"name":"Cliff Creek","cost":"$$$$$","regionID":1}
https://rimrockapi.azurewebsites.net/api/retailer/

Returns: List of class Retailer: List<Retailer>

    [
    {"id":1,"name":"Second Ascents","specialty":"Climbing","regionID":1},
    {"id":2,"name":"Yeager's","specialty":"Skiing","regionID":1},
    {"id":3,"name":"Backcountry Essentials","specialty":"Climbing","regionID":1}
    ]
https://rimrockapi.azurewebsites.net/api/retailer/{id}

Returns: class Retailer by id prop: 

    {"id":1,"name":"Second Ascents","specialty":"Climbing","regionID":1}
https://rimrockapi.azurewebsites.net/api/region/

Returns: List of class Region: List<Region>

    [
    {"id":1,"name":"Greater Seattle"}
    {"id":2,"name":"Eastern Washington"}
    ]
https://rimrockapi.azurewebsites.net/api/region/{id}

Returns: class Region by id prop: 

    {"id":1,"name":"Greater Seattle"}

Change Log

0.1.0: 12APR2019 Initial publish

1.0.0: 15APR2019 Deployed; data avaliable from browser.

1.1.0 16APR2019 README overhaul

1.2.0 17APR2019 Swagger docs, seed data expansion

1.3.0 18APR2019 Tests complete