Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robsonmt/json-server-capstone
https://github.com/robsonmt/json-server-capstone
json-api json-server
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/robsonmt/json-server-capstone
- Owner: RobsonMT
- Created: 2022-01-25T19:49:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-03T00:59:12.000Z (almost 3 years ago)
- Last Synced: 2024-11-07T17:34:18.608Z (3 months ago)
- Topics: json-api, json-server
- Language: JavaScript
- Homepage: https://json-server-capstone.herokuapp.com/animes
- Size: 108 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Json-server-capstone](https://json-server-capstone.herokuapp.com/)
## Endpoints
- [/users](#1)
- [/animes](#2)
- [/mylist](#3)
- [/comments](#4)
- [/avatars](#5)
## Cadastro
`POST /register`
`POST /signup`
`POST /users`
Qualquer um desses 3 endpoints irá cadastrar um novo usuário.
Os campos obrigatórios são os de email email e password.
`POST /signup - FORMATO DA REQUISIÇÃO`
```json
{
"name": "jhondoe",
"email": "[email protected]",
"password": "123456"
}
```
`POST /signup - FORMATO DA RESPOSTA - 200 Created`
```json
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InJvYmVydEBnbWFpbC5jb20iLCJpYXQiOjE2NDIwMzgyMTcsImV4cCI6MTY0MjA0MTgxNywic3ViIjoiMSJ9.lJR--iEy4tPaSP31MPAnnOWoKK3aeaJTTkzLWnCkiYg",
"user": {
"email": "[email protected]",
"name": "jhondoe",
"id": 1
}
}
```
### Possiveis erros
Caso esteja tentando adicionar um novo usuário com um email que já esteja cadastrado.
`POST /signup - FORMATO DA RESPOSTA - 400 Bad Request`
```json
{
"name": "JhonDoe",
"email": "[email protected]",
"password": "123456"
}
```
`Retorno:`
```json
"Email already exists"
```
## Login
`POST /login`
`POST /signin`
Qualquer um desses 2 endpoints pode ser usado para realizar login.
`POST /signin - FORMATO DA REQUISIÇÃO`
```json
{
"email": "[email protected]",
"password": "123456"
}
```
`POST /signin - FORMATO DA RESPOSTA - 200 OK`
```json
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InJvYmVydEBnbWFpbC5jb20iLCJpYXQiOjE2NDIwMzgwNDEsImV4cCI6MTY0MjA0MTY0MSwic3ViIjoiMSJ9.hEyFlcAYVivNsX4OB-bK7yBW-abLzoBfeeVCI4FD1Yg",
"user": {
"email": "[email protected]",
"name": "Robson",
"id": 1
}
}
```
### Possíveis erros
Caso email ou senha digitados estejam incorretos.
`POST /signin - FORMATO DA REQUISIÇÃO`
```json
{
"email": "[email protected]",
"password": "000404"
}
```
`POST /signin - FORMATO DA RESPOSTA - 400 Bad Request`
Caso email incorreto
```json
"Cannot find user"
```
Caso password incorreto
```json
"Incorrect password"
```
## Atualizar dados do usuário
E possível atualizar qualquer dado do usuário sendo necessário passar o número do id do usuário no caminho da requisição. Esta rota necessita de autenticação ,todas as rotas que necessitam de autenticação e necessário passar o accessToken no header da requisição.
`Exemplo:`
{
"headers": {
"Authorization": `Bearer: ${accessToken}`
}
}
`PATCH /users/1 - FORMATO DA REQUISIÇÃO`
```json
{
"name": "Robson",
"email": "[email protected]",
"password": "654321"
}
```
`PATCH /users/1 - FORMATO DA RESPOSTA - 200 OK`
```json
{
"email": "[email protected]",
"password": "$2a$10$3svpjhnOoDOPpc4fnPYNkuDRIJbGkCPXLxNmne0bqemFy.fErAZUu",
"name": "Robson",
"id": 1
}
```
### Possíveis erros
> Caso id não pertença ao usuário. `401 Unauthorized`
```json
"Cannot read properties of undefined (reading 'id')"
```
> Caso id não tenha sido passado na requisição. `403 Forbidden`
```json
"Private resource access: entity must have a reference to the owner id"
```
> Caso acessToken não tenha sido passado na requisição. `401 Unauthorized`
```json
"Missing token"
```
## Animes
Lista todos os animes cadastrados, sendo 56 animes no momento. Todos os usuários tem acesso a está rota, porém somente usuários logados podem comentar e avaliar os animes.
`GET /animes - FORMATO DA RESPOSTA - 200 OK`
```json
[
{
"id": 1,
"title": "Naruto: Shippuuden",
"category": ["Ação", "Angústia", "Comédia", "Artes marciais"],
"rate": [],
"banner_url": "https://media.kitsu.io/anime/cover_images/1555/original.jpg",
"image_url": "https://media.kitsu.io/anime/poster_images/1555/large.jpg",
"original": "Naruto: Shippuden",
"status": "Concluído",
"launch_date": "2007",
"studio": "Pierrot, Studio Pierrot",
"synopsis": "Já se passaram dois anos e meio desde que Naruto Uzumaki deixou Konohagakure, a Vila Oculta da Folha, para um treinamento intenso após os eventos que alimentaram seu desejo de ser mais forte. Agora a Akatsuki, a misteriosa organização de ninjas desonestos de elite, está se aproximando de seu grande plano que pode ameaçar a segurança de todo o mundo shinobi. Embora Naruto seja mais velho e eventos sinistros surjam no horizonte, ele mudou pouco em personalidade - ainda indisciplinado e infantil - embora agora esteja muito mais confiante e possua uma determinação ainda maior para proteger seus amigos e sua casa. Aconteça o que acontecer, Naruto seguirá lutando pelo que é importante para ele, mesmo às custas de seu próprio corpo, na continuação da saga sobre o menino que deseja se tornar Hokage. (Fonte: MAL Rewrite)."
},
{
"id": 2,
"title": "One Piece",
"category": ["Ação", "Crime", "Comédia", "Pirata"],
"rate": [],
"banner_url": "https://media.kitsu.io/anime/12/cover_image/21ecb556255bd46b95aea4779d19789f.jpg",
"image_url": "https://media.kitsu.io/anime/poster_images/12/large.jpg",
"original": "One Piece",
"status": "Em exibição",
"launch_date": "1999",
"studio": "Toei Animation",
"synopsis": "Gol D. Roger era conhecido como o 'Rei dos Piratas', o ser mais forte e mais infame que navegou na Grand Line. A captura e morte de Roger pelo Governo Mundial trouxe uma mudança em todo o mundo. Suas últimas palavras antes de sua morte revelaram a existência do maior tesouro do mundo, One Piece. Foi essa revelação que trouxe a Grande Era dos Piratas, homens que sonhavam em encontrar One Piece - que promete uma quantidade ilimitada de riqueza e fama - e possivelmente o auge da glória e o título de Rei dos Piratas. Entra Monkey D. Luffy, um garoto de 17 anos que desafia sua definição padrão de pirata. Em vez da persona popular de um pirata perverso, endurecido e desdentado saqueando aldeias por diversão, a razão de Luffy ser um pirata é de pura admiração: o pensamento de uma aventura emocionante que o leva a pessoas intrigantes e, finalmente, ao tesouro prometido. Seguindo os passos de seu herói de infância, Luffy e sua tripulação viajam pela Grand Line, vivenciando aventuras loucas, desvendando mistérios sombrios e lutando contra inimigos fortes, tudo para alcançar a mais cobiçada de todas as fortunas – One Piece."
}
]
```
## Adicionando animes a lista
Para adicionar um anime a lista e necessário passar o corpo do anime selecionado, adicionando a propriedade "urserId" com o id do usuário.
`POST /mylist - FORMATO DA RESPOSTA - 201 Created`
```json
{
"id": 1,
"title": "Naruto: Shippuuden",
"category": ["Ação", "Angústia", "Comédia", "Artes marciais"],
"rate": [],
"banner_url": "https://media.kitsu.io/anime/cover_images/1555/original.jpg",
"image_url": "https://media.kitsu.io/anime/poster_images/1555/large.jpg",
"original": "Naruto: Shippuden",
"status": "Concluído",
"launch_date": "2007",
"studio": "Pierrot, Studio Pierrot",
"synopsis": "Já se passaram dois anos e meio desde que Naruto Uzumaki deixou Konohagakure, a Vila Oculta da Folha, para um treinamento intenso após os eventos que alimentaram seu desejo de ser mais forte. Agora a Akatsuki, a misteriosa organização de ninjas desonestos de elite, está se aproximando de seu grande plano que pode ameaçar a segurança de todo o mundo shinobi. Embora Naruto seja mais velho e eventos sinistros surjam no horizonte, ele mudou pouco em personalidade - ainda indisciplinado e infantil - embora agora esteja muito mais confiante e possua uma determinação ainda maior para proteger seus amigos e sua casa. Aconteça o que acontecer, Naruto seguirá lutando pelo que é importante para ele, mesmo às custas de seu próprio corpo, na continuação da saga sobre o menino que deseja se tornar Hokage.",
"userId": 1
}
```
## Listando meus animes
Para listar os seus animes adicionados e necessário passar o userId no corpo da requisição.
Ex: users/:userId/mylist
`GET users/1/mylist - FORMATO DA RESPOSTA - 200 OK`
```json
{
"id": 1,
"title": "Naruto: Shippuuden",
"category": ["Ação", "Angústia", "Comédia", "Artes marciais"],
"rate": [],
"banner_url": "https://media.kitsu.io/anime/cover_images/1555/original.jpg",
"image_url": "https://media.kitsu.io/anime/poster_images/1555/large.jpg",
"original": "Naruto: Shippuden",
"status": "Concluído",
"launch_date": "2007",
"studio": "Pierrot, Studio Pierrot",
"synopsis": "Já se passaram dois anos e meio desde que Naruto Uzumaki deixou Konohagakure, a Vila Oculta da Folha, para um treinamento intenso após os eventos que alimentaram seu desejo de ser mais forte. Agora a Akatsuki, a misteriosa organização de ninjas desonestos de elite, está se aproximando de seu grande plano que pode ameaçar a segurança de todo o mundo shinobi. Embora Naruto seja mais velho e eventos sinistros surjam no horizonte, ele mudou pouco em personalidade - ainda indisciplinado e infantil - embora agora esteja muito mais confiante e possua uma determinação ainda maior para proteger seus amigos e sua casa. Aconteça o que acontecer, Naruto seguirá lutando pelo que é importante para ele, mesmo às custas de seu próprio corpo, na continuação da saga sobre o menino que deseja se tornar Hokage.",
"userId": 1
}
```
## Removendo animes da lista
Para remover animes da lista é necessário passar id do item selecionado no caminho da requisição.
`DELETE /mylist/1 - FORMATO DA RESPOSTA - 200 OK`
```json
{}
```
## Adicionando comentários
Para poder adicionar um comentário e necessário o usuário estar logado. Contendo o 'userId' ,'animeId': contendo o id do anime selecionado.
`POST /comments - FORMATO DA RESPOSTA - 201 Created`
```json
{
"userId": 1,
"animeId": 55,
"comment": "Esse ainda não assisti"
}
```
## Atualizar comentário
Para atualizar um comentário e necessário passar o id do comentário no caminho da requisição
`PATCH/comments/1 - FORMATO DA REQUISIÇÃO - 200 OK`
```json
{
"comment": "Assisti ele ontem, muito bom!!"
}
```
## Remover comentário
Para remover um comentário e necessário passar o id do comentário selecionado no caminho da requisição.
`DELETE/comments/1 - FORMATO DA REQUISIÇÃO - 200 OK`
```json
{
"comment": "Assisti ele ontem, muito bom!!"
}
```
## Listar comentários
Para listar os comentários.
`GET/comments - FORMATO DA REQUISIÇÃO - 200 OK`
```json
{
"userId": 1,
"animeId": 55,
"comment": "Esse ainda não assisti"
}
```
## Listar um comentário em especifíco
Para listar um comentários de um anime em especifíco e necessário passar o id do anime no qual esteja procurando no caminho da requisição.
`GET/comments?animeId=55 - FORMATO DA REQUISIÇÃO - 200 OK`
```json
{
"userId": 1,
"animeId": 55,
"comment": "Esse ainda não assisti"
}
```
## Avatars
Para listar os avatares padrões de usuário.
`GET/avatars - FORMATO DA REQUISIÇÃO - 200 OK`
```json
[
"https://icon-library.com/images/anime-icon/anime-icon-9.jpg",
"http://pm1.narvii.com/6861/44017694789ca7409a0a9a30a8c0be4a7e2bd9f8r1-800-713v2_00.jpg",
"https://icon-library.com/images/cool-anime-icon/cool-anime-icon-9.jpg",
"https://wallpapercave.com/uwp/uwp1426727.jpeg"
]
```