Neste projeto contém dois endpoints desenvolvidos usando o framework FastAPI. Abaixo está uma descrição de cada um deles.

• Certifique-se de ter o Docker instalado na sua máquina.
• Crie uma imagem Docker a partir do Dockerfile incluído no projeto:

  $ docker build -t app .

• Execute o projeto usando o Docker Compose:

  $ docker-compose up

• Para iniciar o servidor local do app https://localhost:8000

Swagger

• URL LOCAL:https://127.0.0.1:8000/api
• URL PRODUCTION: https://apiwords.up.railway.app/api

Este endpoint recebe uma lista de palavras e retorna a contagem de vogais em cada palavra. As palavras são enviadas no corpo da requisição em formato JSON.

• Método: POST
• URL: /vowel_count
• Corpo da Requisição (JSON):

  {
  "words": ["hello", "world", "example"]
}
	

A resposta é um objeto JSON contendo a contagem de vogais para cada palavra enviada.

Exemplo de resposta bem-sucedida:

{
	"hello": 2,
	"world": 1,
	"example": 3
}

Este endpoint recebe uma lista de palavras e um parâmetro opcional reverse para especificar se a ordem deve ser invertida. As palavras são enviadas no corpo da requisição em formato JSON.

• Método: POST
• URL: /sort
• Corpo da Requisição (JSON):

{
	"words": ["hello", "world", "example"],
	"order": "asc"
}

A resposta é um objeto JSON contendo a lista de palavras ordenada de acordo com a configuração de inversão.

Exemplo de resposta bem-sucedida com order = asc:

{
	"words": ["hello", "world", "example"]
}

Exemplo de resposta bem-sucedida com order = desc:

{
	"words": ["example", "world", "hello"]
}