Skip to content

complete deliverable #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nholliday314 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

complete deliverable #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ The above could be described as a template for a `REST API's` endpoints that all
* as a sub note, notice that this allows us to avoid url/route _anti-patterns_ such as redundancies like `POST /users/new` or `PATCH /users/:user_id/update` which communicates nothing extra by lengthening the url with useless information that is not related to the resource that is having an action taken on it.
* when `POST`ing, `PUT`ing, `PATCH`ing, or `DELETE`ing there are different options on how to handle the response, the best choice being dependant on how your API needs to work



### Planning Blog Functionality

Our API is off to a great start, lets talk about some of the other features we need to implement:
Expand Down Expand Up @@ -149,10 +151,42 @@ Your Task is to write a `RESTful` routing chart for the library system's API. Yo

You can use this markdown chart:

```
member = {
name: string
id: ObjectId()
phoneNumber: string
email: string
isActive: Boolean (defaults to true)
fineAmount: Number
checkOutBooks: [ObjectIds(ref to a book)]
}
// 1:M members:books
book = {
title: string
...
checkedOutBy: ObjectId(ref to member who checked it out)
}
```

| HTTP METHOD (_Verb_) | URL (_Nouns_) | CRUD | Response | Notes |
| -------------------- | ------------- | ---- | -------- | ----- |
| | | | | |
| | | | | |
| `members` | | | | |
| GET | /members | READ | array of members | |
| GET | /members/:memberId | READ | single member with id of :memberId | |
| POST | /members | CREATE | add member to library | |
| PUT/PATCH | /members/:memberId | UPDATE | update member with id of :memberId | |
| DELETE | /members/:memberId | DESTROY | destroy member with id of :memberId | |
| PUT/PATCH (maybe post) | /members/:memberId/books/:bookId | UPDATE | associate the member with id of :memberId to the book with an id of :bookId | |
| `books` | | | | |
| GET | /books | READ | array of books | |
| GET | /books/:bookId | READ | single book with id of :bookId | |
| POST | /books | CREATE | add book to library | |
| PUT/PATCH | /books/:bookId | UPDATE | update book with id of :bookId | |
| DELETE | /books/:bookId | DESTROY | destroy book with id of :bookId | |
| DELETE | /books/:bookId/members/:memberId | UPDATE | remove the book with an id of :bookId from the member with an id of :memberId | |



#### Things to keep in mind

Expand Down