search

RoboTigers / FRCScout2020

MIT License
1 stars 8 forks source link

RESTful Design #23

Closed sharonkass closed 4 years ago

sharonkass commented 4 years ago

We have two routing strategies: the express routes and the react routes for navigating the Single Page Application. This issue can involve both but is mostly focused on the restful express routes.

Here is a proposal for a restful design:

/api/competition/:shortName/team /api/competition/:shortName/team/:teamNum /api/competition/:shortName/team/:teamNum/pit /api/competition/:shortName/team/:teamNum/pit/:pitId /api/competition/:shortName/team/:teamNum/match /api/competition/:shortName/team/:teamNum/match/:matchId /api/competition/:shortName/pit /api/competition/:shortName/match /api/pit/:pitId /api/match/:matchId

See matchRouter.js for example.

sharonkass commented 4 years ago

Discussed with team on Jan 30 and agreed. Yay!

sharonkass commented 4 years ago

https://martinfowler.com/articles/richardsonMaturityModel.html