Bibliotecas usadas nesse projeto:

• Typescript
• Fastify
• Fastify/Cors
• Prisma
• SQLite
• Zod
• fastify-type-provider-zod
• Dayjs
• nodemailer

Rotas de Criação

POST

Create Trip - /trips

Padrão de corpo:

{
  "destination": "string",
  "starts_at": "string",
  "ends_at": "string",
  "owner_name": "string",
  "owner_email": "string",
  "emails_to_invite": "string"
}

Padrão de resposta:

{
  "tripId": "string"
}

Possíveis Erros

• 400 - Invalid trip start date
• 400 - Invalid trip end date

Create Link - /trips/:tripId/links

Padrão de corpo:

"body": {
  "title": "string",
  "url": "string",
},
"params": {
    "tripId": "string"
}

Padrão de resposta:

{
  "linkId": "string"
}

Possíveis Erros

• 400 - Trip not found

Create Invite - /trips/:tripId/invites

Padrão de corpo:

"body": {
  "email": "string"
},
"params": {
    "tripId": "string"
}

Padrão de resposta:

{
  "participantId": "string"
}

Possíveis Erros

• 400 - Trip not found

Create Activity - /trips/:tripId/activities

Padrão de corpo:

"body": {
  "title": "string",
  "occurs_at": "string (Convertido para data)" 
},
"params": {
    "tripId": "string"
}

Padrão de resposta:

{
  "activityId": "string"
}

Possíveis Erros

• 400 - Trip not found
• 400 - Invalid activity date

Rotas de Leitura

GET

Get Activities - /trips/:tripId/activities

Padrão de corpo:

"params": {
    "tripId": "string"
}

Padrão de resposta:

return { "activities": "trip.activities" },

{
    "id": "string",
    "title": "string",
    "occurs_at": "Date",
    "trip_id": "string"
}

Possíveis Erros

• 400 - Trip not found

Get Links - /trips/:tripId/links

Padrão de corpo:

"params": {
    "tripId": "string"
}

Padrão de resposta:

return { "links": "trip.links" },

{
    "id": "string",
    "title": "string",
    "url": "string",
    "trip_id": "string"
}

Possíveis Erros

• 400 - Trip not found

Get One Participant - /participants/:participantId

Padrão de corpo:

"params": {
    "participantId": "string"
}

Padrão de resposta:

{
    "id": "string",
    "is_confirmed": "boolean",
    "name": "string | null",
    "email": "string"
}

Possíveis Erros

• 400 - Participant not found

Get Participant - /trips/:tripId/participants

Padrão de corpo:

"params": {
    "tripId": "string"
}

Padrão de resposta:

return { "participants": "trip.participants" }

{
    "id": "string",
    "is_confirmed": "boolean",
    "name": "string | null",
    "email": "string"
}

Possíveis Erros

• 400 - Trip not found

Get Trip - /trips/:tripId

Padrão de corpo:

"params": {
    "tripId": "string"
}

Padrão de resposta:

{
    "destination": "string",
    "starts_at": "Date",
    "ends_at": "Date",
    "id": "string",
    "is_confirmed": "boolean"
}

Possíveis Erros

• 400 - Trip not found

Confirm Trip - /trips/:tripId/confirm

Padrão de corpo:

"params": {
    "tripId": "string"
}

Padrão de resposta:

"return reply.redirect(`${env.API_BASE_URL}/trips/${tripId}`)"

Possíveis Erros

• 400 - Trip not found

Confirm Participant - /participants/:participantId/confirm

Padrão de corpo:

"params": {
    "tripId": "string",
    "participantId": "string"
}

Padrão de resposta:

"return reply.redirect(`${env.WEB_BASE_URL}/trips/${participant.trip_id}`)"

Possíveis Erros

• 400 - Participant not found

Rotas de Update

PUT

Update Trip - /trips/:tripId

Padrão de corpo:

"body": {
  "destination": "string",
  "starts_at": "string (Convertido para data)",
  "ends_at": "string (Convertido para data)"  
},
"params": {
    "tripId": "string"
}

Padrão de resposta:

{
  "tripId": "string"
}

Possíveis Erros

• 400 - Trip not found
• 400 - Invalid trip start date
• 400 - Invalid trip end date

Dica:

Mailtrap.io - Caso no futuro eu queira testar o envio de emails em uma aplicação de forma gratuita