Sua tarefa é construir uma API e banco de dados para a aplicação VUTTR (Very Useful Tools to Remember). A aplicação é um simples repositório para gerenciar ferramentas com seus respectivos nomes, links, descrições e tags. Utilize um repositório Git (público, de preferência) para versionamento e disponibilização do código.
A aplicação pode ser construída utilizando qualquer linguagem, banco de dados, frameworks, libraries e ferramentas de sua preferência (Ex: Node + Express + Mongoose + MongoDB, PHP + Lumen + RedBean + PostgreSQL, etc). Apesar disso, a stack mais comum para squads aqui na BossaBox é Node.js, seguida por PHP. Ruby é incomum, mas aparece em raros casos.
A API deverá ser documentada utilizando o formato API Blueprint ou Swagger.
Queremos avaliar sua capacidade de desenvolver e documentar um back-end para uma aplicação. Serão avaliados:
- Código bem escrito e limpo;
- Quais ferramentas foram usadas, como e porquê, além do seu conhecimento das mesmas;
- Seu conhecimento em banco de dados, requisições HTTP, APIs REST, etc;
- Sua capacidade de se comprometer com o que foi fornecido;
- Sua capacidade de documentação da sua parte da aplicação.
- Uma aplicação contendo uma API real simples, sem autenticação, que atenda os requisitos descritos abaixo, fazendo requisições à um banco de dados para persistência;
- README.md contendo informações básicas do projeto e como executá-lo;
- API Blueprint ou Swagger da aplicação.
Os seguintes itens não são obrigatórios, mas darão mais valor ao seu trabalho (os em negrito são mais significativos para nós, se destacando como características para se tornar Tech Lead em squads)
- Uso de ferramentas externas que facilitem o seu trabalho;
- Cuidados especiais com otimização, padrões, entre outros;
- Migrations ou script para configuração do banco de dados utilizado;
- Testes;
- Conteinerização da aplicação;
- Autenticação e autorização (OAuth, JWT);
- Pipelines de CI/CD (GitLab, CircleCI, TravisCI, etc);
- Deploy em ambientes reais, utilizando serviços de cloud externos (AWS, Heroku, GCP, etc);
- Sugestões sobre o challenge embasadas em alguma argumentação.
GET /tools
Resposta:
[
{
id: 1, // ou qualquer outro identificador
title: "Notion",
link: "https://notion.so",
description: "All in one tool to organize teams and ideas. Write, plan, collaborate, and get organized. ",
tags: [
"organization",
"planning",
"collaboration",
"writing",
"calendar"
]
},
{
id: 2,
title: "json-server",
link: "https://github.com/typicode/json-server",
description: "Fake REST API based on a json schema. Useful for mocking and creating APIs for front-end devs to consume in coding challenges.",
tags: [
"api",
"json",
"schema",
"node",
"github",
"rest"
]
},
{
id: 3,
title: "fastify",
link: "https://www.fastify.io/",
description: "Extremely fast and simple, low-overhead web framework for NodeJS. Supports HTTP2.",
tags: [
"web",
"framework",
"node",
"http2",
"https",
"localhost"
]
}
]
GET /tools?tag=node (node é a tag sendo buscada neste exemplo)
Resposta:
[
{
id: 2, // ou qualquer outro identificador
title: "json-server",
link: "https://github.com/typicode/json-server",
description: "Fake REST API based on a json schema. Useful for mocking and creating APIs for front-end devs to consume in coding challenges.",
tags: [
"api",
"json",
"schema",
"node",
"github",
"rest"
]
},
{
id: 3,
title: "fastify",
link: "https://www.fastify.io/",
description: "Extremely fast and simple, low-overhead web framework for NodeJS. Supports HTTP2.",
tags: [
"web",
"framework",
"node",
"http2",
"https",
"localhost"
]
}
]
O corpo da requisição deve conter as informações da ferramenta a ser cadastrada, sem o ID (gerado automaticamente pelo servidor). A resposta, em caso de sucesso, deve ser o mesmo objeto, com seu novo ID gerado.
POST /tools Content-Type: application/json
{
"title": "hotel",
"link": "https://github.com/typicode/hotel",
"description": "Local app manager. Start apps within your browser, developer tool with local .localhost domain and https out of the box.",
"tags":["node", "organizing", "webapps", "domain", "developer", "https", "proxy"]
}
Resposta:
Status: 201 Created
Content-Type: application/json
{
"title": "hotel",
"link": "https://github.com/typicode/hotel",
"description": "Local app manager. Start apps within your browser, developer tool with local .localhost domain and https out of the box.",
"tags":["node", "organizing", "webapps", "domain", "developer", "https", "proxy"],
"id":5 // ou qualquer outro identificador
}
DELETE /tools/:id
Resposta:
Status: 204 No Content
- A API deve ser real e escrita por você. Ferramentas que criam APIs automaticamente (Loopback, json-server, etc) não são aceitas;
- Todos os requisitos acima devem ser cumpridos, seguindo o padrão de rotas estabelecido;
- Deve haver um documento de API Blueprint ou OpenAPI (antigo Swagger) descrevendo sua API;
- Se você julgar necessário, adequado ou quiser deixar a aplicação mais completa (bônus!) você pode adicionar outras rotas, métodos, meios de autenticação com usuários, etc.
Quando terminar de realizar o desafio você deverá gravar um vídeo de no máximo 30 minutos (mas não se prenda a esse número, ele é apenas um guia. Use o tempo necessário que precisar), contando pra gente esses principais pontos:
- Um pouco sobre você, o que gosta de fazer, como chegou nessa carreira e tudo mais;
- Como conheceu a BossaBox e porque se interessou por ela;
- Como é a sua rotina hoje;
- Quanto tempo você pode se dedicar à projetos da BossaBox durante a semana;
- Compartilhe sua tela no vídeo e mostre o que você construiu no desafio, passando sobre o código e o resultado final, e os pontos que você julga importante para o funcionamento do mesmo;
- As decisões que teve que tomar para construí-lo;
- Ferramentas utilizadas e porquê;
Você encontrará mais informações sobre a ferramenta de vídeo aqui: