Projects/Biblio
Projects
/
Biblio
Archived
3
0
Fork 0
Code Issues Pull Requests 6 Activity

Added routes.

This commit is contained in:
Rikke Solbjørg 2019-08-21 11:08:03 +00:00 committed by GitHub
parent 99f2c5e7d8
commit cb03e559b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -15,3 +15,25 @@ npm start [password]
ExpressJS is used for routing, bcrypt is used for passwords, mongoose is used to interface with MongoDB.
HATEOAS isn't implemented yet.
In lieu of Swagger:
```
GET /books: List all books in library.
POST /books: Add a book to the library.
GET /books/:bookId : Get specific entry for a book.
PUT /books/:bookId : Requires update_books permission. Updates entry for book.
DELETE /books/:bookId : Requires delete_books permission. Deletes entry for book.
GET /users: List all users in library.
POST /users: Requires add_users permission. Add a user to the system. If any non-default permissions are needed, change_permissions is required.
GET /users/:userId : Get specific user entry.
PUT /users/:userId : Requires update_users permission. Updates user entry.
DELETE /users/:userId : Requires delete_users permission. Deletes user. Not allowed if user is currently borrowing any books.
GET /borrow: Requires borrow_books permission. Lists logged in user's borrowed books.
PUT /borrow: Borrows a book, sent in the format { bookId: [id] }.
DELETE /borrow: Deletes a book, sent in the format { bookId: [id] }.
```