Skip to content

tapriandi #16

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
tapriandi wants to merge 6 commits into
base: master
Choose a base branch
from
Open

tapriandi #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d5cf91e
login register crud-question
tapriandi Aug 28, 2019
9954933
update edit-question
tapriandi Aug 28, 2019
0bad95a
add answer
tapriandi Aug 29, 2019
f9d17f2
update crud answer question
tapriandi Aug 29, 2019
9e9ec9a
tapriandi
tapriandi Aug 29, 2019
d2d7e43
tapriandi
tapriandi Aug 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
392 changes: 391 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,391 @@
# hacktivoverflow
# hacktivoverflow

# E-commerce API

Routes
---
Access deploy : http://andicloud.s3-website-ap-southeast-1.amazonaws.com/

### product

- base routes Question : http://localhost:3000/api/question

- GET : /
- description: Get all question
- body : none
- Headers : none
- Response :
- Success :
Status Code : 200
```
[{
"userId":"5d590f86177f4e9993faf440",
"title":"title question",
"tas":"shoes",
"upVote":"1",
"downVote":"10",
"content":"lorem ipsum dolor",
"answer":['user_id'],
"created_at":"2019-29-18T08:42:46.543Z","
updatedAt":"2019-29-18T08:42:51.334Z",
"__v":0
}]
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

- GET : /:id
- description : Get question by id
- body : none
- Headers : none
- Response :
- Success :
Status Code : 200
```
[{
"userId":"5d590f86177f4e9993faf440",
"title":"title question",
"tas":"shoes",
"upVote":"1",
"downVote":"10",
"content":"lorem ipsum dolor",
"answer":['user_id'],
"created_at":"2019-29-18T08:42:46.543Z","
updatedAt":"2019-29-18T08:42:51.334Z",
"__v":0
}]
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

- GET : /owner/:id
- description : Get question by owner
- body : none
- Headers : none
- Response :
- Success :
Status Code : 200
```
[{
"userId":"5d590f86177f4e9993faf440",
"title":"title question",
"tas":"shoes",
"upVote":"1",
"downVote":"10",
"content":"lorem ipsum dolor",
"answer":['user_id'],
"created_at":"2019-29-18T08:42:46.543Z","
updatedAt":"2019-29-18T08:42:51.334Z",
"__v":0
}]
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

- POST : /
- description : Create question
- body : yes
- Headers : yes
- Response :
- Success :
Status Code : 200
```
[{
"userId":"5d590f86177f4e9993faf440",
"title":"title question",
"tas":"shoes",
"upVote":"1",
"downVote":"10",
"content":"lorem ipsum dolor",
"answer":['user_id'],
"created_at":"2019-29-18T08:42:46.543Z","
updatedAt":"2019-29-18T08:42:51.334Z",
"__v":0
}]
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

Status Code : 401
```
{
"message": "Unauthorized user"
}
```

- PATCH : /:id
- description : Update qestion
- body : yes
- params : id
- Headers : yes
- Response :
- Success :
Status Code : 200
```
[{
"userId":"5d590f86177f4e9993faf440",
"title":"title question",
"tas":"shoes",
"upVote":"1",
"downVote":"10",
"content":"lorem ipsum dolor",
"answer":['user_id'],
"created_at":"2019-29-18T08:42:46.543Z","
updatedAt":"2019-29-18T08:42:51.334Z",
"__v":0
}]
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

Status Code : 401
```
{
"message": "Unauthorized user"
}
```

- DELETE : /:id
- description : Delete Question
- body : none
- Headers : yes
- Params : id
- Response :
- Success :
Status Code : 200
```
{
"userId":"5d590f86177f4e9993faf440",
"title":"title question",
"tas":"shoes",
"upVote":"1",
"downVote":"10",
"content":"lorem ipsum dolor",
"answer":['user_id'],
"created_at":"2019-29-18T08:42:46.543Z","
updatedAt":"2019-29-18T08:42:51.334Z",
"__v":0
}
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

Status Code : 401
```
{
"message": "Unauthorized user"
}
```

- PATCH : /vote
- description : vote and unvote question
- params : questionID
- Headers : yes
- Response :
- Success :
Status Code : 200

- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

Status Code : 401
```
{
"message": "Unauthorized user"
}
```
### Answer

- base routes USER url : http://localhost:3000/api/answer

- GET /:id
- description : get answer base on id question
- body : none
- params : question id
- Headers : yes
- Response :
- Success :
Status Code : 200
```
{
"message" : "data is deleted"
}
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

Status Code : 401
```
{
"message": "Unauthorized user"
}
```

- POST : /
- description : create a new user
- body :
```
{
question : your content question,
}
```
- Headers : yes
- Response :
- Success :
Status Code : 201
```
{
"_id":"5d6745cce3a36669ea9160a8",
"upVote":"array",
"downVote":"array",
"content":"your content comment",
"userId":5d65fb17d3f50137468543dc",
"questionId":"5d66c1ca4528ed2626adf580",
"__v":0
}
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```
Status Code : 401
```
{
"message": "Unauthorized user"
}
```

- PATCH : /:id
- description : update answer
- body : none
- params : answer id
- Headers : yes
- Response :
- Success :
Status Code : 200
```
{
"message": "update success"
}
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```
Status Code : 401
```
{
"message": "Unauthorized user"
}
```

- DELETE : /:id
- description : delete answer
- body : none
- params : answer id
- Headers : yes
- Response :
- Success :
Status Code : 200
```
{
"message": "delete success"
}
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```
Status Code : 401
```
{
"message": "Unauthorized user"
}
```

### User

- base routes USER url : http://localhost:3000/api/user

- POST /register
- description : register account
- body : yes
- params : none
- Headers : none
- Response :
- Success :
Status Code : 201
```
{ "_id":"5d4fcfcfe892dd5c17e365c6",
"name":"budi",
"email":budio@gmail.com",
"password":"$2a$10$KElSSENK14IoN4zsyY",
"__v":0
}
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

- POST : /login
- description : login user
- body : yes "email and password"
- Headers : none
- Response :
- Success :
Status Code : 201
```
{ "_id":"5d4fcfcfe892dd5c17e365c6",
"name":"budi",
"email":budio@gmail.com",
"password":"$2a$10$KElSSENK14IoN4zsyY",
"__v":0
}
```
- Error :
Status Code : 500
```
{"message" : "Internal Server Error"}
```

Usage
----

Make sure you have node js has been installed in your computer, then run the folder <b>server</b> the commands bellow in your terminal.

```
$ 'npm init -y'
$ 'npm install'
$ 'nodemon app.js' for server
$ 'npm run serve' for clint
```

Loading