Skip to content

Latest commit

 

History

History
336 lines (336 loc) · 10.5 KB

documentacao.md

File metadata and controls

336 lines (336 loc) · 10.5 KB
Raw

Documentação Prova Prática Bussola - Marvel API (King in Black)

Characters

GET - /api/characters

Retorna todos os characters cadastrados no banco

Exemplo de retorno:

[
        {
        "_id": "6636cc889a09d997d78aa1b3",
        "name": "Avengers",
        "description": "Earth's Mightiest Heroes joined forces to take on threats that were too big for any one hero to tackle. With a roster that has included Captain America, Iron Man, Ant-Man, Hulk, Thor, Wasp and dozens more over the years, the Avengers have come to be regarded as Earth's No. 1 team.",
        "createdAt": "2024-05-05T00:02:16.093Z",
        "updatedAt": "2024-05-05T00:02:16.093Z",
        "__v": 0
    },
    {
        "_id": "6636cc889a09d997d78aa1b5",
        "name": "Doctor Strange",
        "description": "",
        "createdAt": "2024-05-05T00:02:16.404Z",
        "updatedAt": "2024-05-05T00:02:16.404Z",
        "__v": 0
    },
    {
        "_id": "6636cc889a09d997d78aa1b7",
        "name": "Eddie Brock",
        "description": "",
        "createdAt": "2024-05-05T00:02:16.723Z",
        "updatedAt": "2024-05-05T00:02:16.723Z",
        "__v": 0
    }
    ]

Typagem do Retorno

[
        "id": String,
        "name": String,
        "description": String,
        "createdAt": Timestamp,
        "updatedAt": Timestamp
    ]

Códigos de Resposta:

  • 200 - Retorna os characters com sucesso
  • 500 - Erro interno do servidor

GET - /api/characters/:id

Retona um character específico pelo id

Códigos de Resposta:

  • 200 - Retorna o character com sucesso
  • 500 - Erro interno do servidor

POST - /api/characters

Realiza a criação de um novo character

Corpo Necessário:

{
        "name": String,
        "description": String
    }

Códigos de Resposta:

  • 201 - Realizou a criação do novo character com sucesso
  • 500 - Erro interno do servidor

PUT - /api/characters/:id

Realiza a atualização de um character específico pelo id com o corpo passado na requisição

Corpo Necessário:

{
        "name": String,
        "description": String
    }

Códigos de Resposta:

  • 200 - Realizou a atualização do character com sucesso
  • 500 - Erro interno do servidor

DELETE - /api/characters/:id

Realiza a exclusão de um character específico pelo id

Códigos de Resposta:

  • 204 - Realizou a exclusão do character com sucesso
  • 500 - Erro interno do servidor

GET - /api/characters/count

Retorna a quantidade de characters no banco

Códigos de Resposta:

  • 200 - Retona a contagem com sucesso
  • 500 - Erro interno do servidor

GET - /api/characters/description-gt-50

Retorna os characters que possuem uma descrição cujo tamanho é maior que 50

Códigos de Resposta:

  • 200 - Retona os characters filtrados com sucesso
  • 500 - Erro interno do servidor

Comics

GET - /api/comics

Retorna todos as comics do banco

Exemplo de retorno:

[
        {
        "_id": "6636cc8c9a09d997d78aa1c1",
        "digitalId": 0,
        "title": "King in Black (2020) #5 (Variant)",
        "issueNumber": 5,
        "variantDescription": "Variant",
        "description": "WHAT'S A GOD TO A NONBELIEVER?",
        "isbn": "",
        "diamondCode": "JAN210528",
        "format": "Comic",
        "pageCount": 48,
        "createdAt": "2024-05-05T00:02:20.833Z",
        "updatedAt": "2024-05-05T00:02:20.833Z",
        "__v": 0
    },
    {
        "_id": "6636cc8d9a09d997d78aa1c3",
        "digitalId": 0,
        "title": "King in Black (2020) #5 (Variant)",
        "issueNumber": 5,
        "variantDescription": "Variant",
        "description": "WHAT'S A GOD TO A NONBELIEVER?",
        "isbn": "",
        "diamondCode": "JAN210523",
        "format": "Comic",
        "pageCount": 48,
        "createdAt": "2024-05-05T00:02:21.145Z",
        "updatedAt": "2024-05-05T00:02:21.145Z",
        "__v": 0
    }
    ]

Typagem do Retorno

[
        "id": String,
        "digitalId": Number,
        "title": String,
        "issueNumber": Number,
        "variantDescription": String,
        "description": String,
        "isbn": String,
        "diamondCode": String,
        "format": String,
        "pageCount": Number,
        "createdAt": Timestamp,
        "updatedAt": Timestamp
    ]

Códigos de Resposta:

  • 200 - Retona as comics com sucesso
  • 500 - Erro interno do servidor

GET - /api/comics/:id

Retona uma comic específica pelo id

Códigos de Resposta:

  • 200 - Retona a comic com sucesso
  • 500 - Erro interno do servidor

POST - /api/comics

Realiza a criação de uma nova comic

Corpo Necessário:

{
        "digitalId": Number,
        "title": String,
        "issueNumber": Number,
        "variantDescription": String,
        "description": String,
        "isbn": String,
        "diamondCode": String,
        "format": String,
        "pageCount": Number
    }

Códigos de Resposta:

  • 201 - Realizou a criação da nova comic com sucesso
  • 500 - Erro interno do servidor

PUT - /api/comics/:id

Realiza a atualização de uma comic específica do banco

Corpo Necessário:

{
        "digitalId": Number,
        "title": String,
        "issueNumber": Number,
        "variantDescription": String,
        "description": String,
        "isbn": String,
        "diamondCode": String,
        "format": String,
        "pageCount": Number
    }

Códigos de Resposta:

  • 200 - Realizou a atualização da comic com sucesso
  • 500 - Erro interno do servidor

DELETE - /api/comics/:id

Realiza a exclusão de uma comic do banco

Códigos de Resposta:

  • 204 - Realizou a exclusão com sucesso
  • 500 - Erro interno do servidor

GET - /api/comics/count

Retorna a quantidade de comics do banco

Códigos de Resposta:

  • 200 - Realizou a contagem com sucesso
  • 500 - Erro interno do servidor

GET - /api/comics/pages-gte-50

Retorna as comics que possuem mais de 50 páginas

Códigos de Resposta:

  • 200 - Retornou as comics com sucesso
  • 500 - Erro interno do servidor

Creators

GET - /api/creators

Retorna todos os creators cadastrados no banco

Exemplo de retorno:

[
        {
        "_id": "6636cc9b9a09d997d78aa205",
        "firstName": "Jesus",
        "middleName": "",
        "lastName": "Aburtov",
        "suffix": "",
        "fullName": "Jesus Aburtov",
        "createdAt": "2024-05-05T00:02:35.808Z",
        "updatedAt": "2024-05-05T00:02:35.808Z",
        "__v": 0
    },
    {
        "_id": "6636cc9c9a09d997d78aa207",
        "firstName": "Erick",
        "middleName": "",
        "lastName": "Arciniega",
        "suffix": "",
        "fullName": "Erick Arciniega",
        "createdAt": "2024-05-05T00:02:36.152Z",
        "updatedAt": "2024-05-05T00:02:36.152Z",
        "__v": 0
    },
    {
        "_id": "6636cc9c9a09d997d78aa209",
        "firstName": "Ian",
        "middleName": "",
        "lastName": "Bederman",
        "suffix": "",
        "fullName": "Ian Bederman",
        "createdAt": "2024-05-05T00:02:36.459Z",
        "updatedAt": "2024-05-05T00:02:36.459Z",
        "__v": 0
    }
    ]

Typagem do Retorno

[
        "id": String,
        "firstName": String,
        "middleName": String,
        "lastName": String,
        "suffix": String,
        "fullName": String,
        "createdAt": Timestamp,
        "updatedAt": Timestamp
    ]

Códigos de Resposta:

  • 200 - Retorna os creators com sucesso
  • 500 - Erro interno do servidor

GET - /api/creators/:id

Retona um creator específico pelo id

Códigos de Resposta:

  • 200 - Retorna o creator com sucesso
  • 500 - Erro interno do servidor

POST - /api/creators

Realiza a criação de um novo creator

Corpo Necessário:

{
        "firstName": String,
        "middleName": String,
        "lastName": String,
        "suffix": String,
        "fullName": String
    }

Códigos de Resposta:

  • 201 - Realizou a criação do novo creator com sucesso
  • 500 - Erro interno do servidor

PUT - /api/creators/:id

Realiza a atualização de um creator específico pelo id com o corpo passado na requisição

Corpo Necessário:

{
        "firstName": String,
        "middleName": String,
        "lastName": String,
        "suffix": String,
        "fullName": String
    }

Códigos de Resposta:

  • 200 - Realizou a atualização do creator com sucesso
  • 500 - Erro interno do servidor

DELETE - /api/creators/:id

Realiza a exclusão de um creator específico pelo id

Códigos de Resposta:

  • 204 - Realizou a exclusão do creator com sucesso
  • 500 - Erro interno do servidor

GET - /api/creators/count

Retorna a quantidade de creators no banco

Códigos de Resposta:

  • 200 - Retona a contagem com sucesso
  • 500 - Erro interno do servidor