Giter Site home page Giter Site logo

backend-challenge's Introduction

BackendChallenge

Tecnologias utilizadas

Utilizei F# com o framework giraffe por ele facilitar o desenvolvimento em um estilo funcional e ser simples de estruturar a aplicação.

O MongoDB foi utilizado como banco de dados pela sua excelente integração com o ecossistema do .NET, estruturando os dados em forma de documentos dentro de coleções.

Rodando a aplicação

Basta copiar o .env, setando a connection string do mongodb e logo depois rodar o docker-compose

cp .env.example .env
docker-compose up

Rotas da aplicação

Serviço de CMS

POST

http://localhost:8080/api/cms

O serviço de CMS irá receber as informações de uma receita e em seguida irá salva-lá no banco de dados. É possível utilizar nos ingredientes tanto o ID de um ingrediente que já existente, quanto as informações de um novo ingrediente. Caso alguma propriedade não seja adicionada no payload, será retornado um erro 422 mostrando que falta aquela propriedade para salvar a receita no banco, fazendo com que os dados fiquem consistentes.

Exemplo de request

curl --location --request POST 'http://localhost:8080/api/cms' \
--data-raw '{
    "name": "A simple recipe",
    "description": "A simple description",
    "ingredients": [
        {
            "quantity": "one quarter",
            "unit": "kg",
            "food": "beef"
        },
        {
            "id": "-h_yXRSQ6kyzVzy4PgdSuQ"
        }
    ],
    "equipments": [
        {
            "tool": "knife",
            "quantity": 1
        }
    ]
}'

Resposta:

{
  "id": "OHmGCfFeq0inlqVH4BXeQg",
  "name": "A simple recipe",
  "description": "A simple description",
  "ingredients": [
    {
      "id": "-h_yXRSQ6kyzVzy4PgdSuQ",
      "food": "some food",
      "quantity": "one quarter",
      "unit": "g"
    },
    {
      "id": "n-eqR0KZCUixMM5wAIzFuA",
      "food": "beef",
      "quantity": "one quarter",
      "unit": "kg"
    }
  ],
  "equipments": [
    {
      "tool": "knife",
      "quantity": 1
    }
  ]
}

Serviço de Receita

Buscar receitas salvas no banco de dados, limitando-se a um batch de 8 receitas por request (paginação)

GET

http://localhost:8080/api/recipes?page=1

Exemplo de request:

curl --location --request GET 'http://localhost:8080/api/recipes?page=1'

Exemplo de Resposta:

{
  "data": [...],
  "totalPages": 4
}

Buscar receitas que contenham o ID especificado do ingrediente

Exemplo de request:

curl --location --request GET 'http://localhost:8080/api/recipes/ingredient/-h_yXRSQ6kyzVzy4PgdSuQ'

Exemplo de resposta:

[
  {
    "id": "40zdPx29BUG4F_SMJCxq7A",
    "name": "teste",
    "description": "uma descrição de exemplo",
    "ingredients": [
      {
        "id": "-h_yXRSQ6kyzVzy4PgdSuQ",
        "food": "some food",
        "quantity": "one quarter",
        "unit": "g"
      },
      {
        "id": "I3JPr_MkRUKtdV_hhZd2-g",
        "food": "chicken",
        "quantity": "10",
        "unit": "kg"
      }
    ],
    "equipments": [
      {
        "tool": "example",
        "quantity": 2
      }
    ]
  },
  {
    "id": "OHmGCfFeq0inlqVH4BXeQg",
    "name": "A simple recipe",
    "description": "A simple description",
    "ingredients": [
      {
        "id": "-h_yXRSQ6kyzVzy4PgdSuQ",
        "food": "some food",
        "quantity": "one quarter",
        "unit": "g"
      },
      {
        "id": "n-eqR0KZCUixMM5wAIzFuA",
        "food": "beef",
        "quantity": "one quarter",
        "unit": "kg"
      }
    ],
    "equipments": [
      {
        "tool": "knife",
        "quantity": 1
      }
    ]
  }
]

backend-challenge's People

Contributors

vitoladev avatar

Watchers

 avatar  avatar

backend-challenge's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.