Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tarcisiooliveira2021/avatarizer-api
Avatarizer: Customização de avatares sensiveis ao contexto.
https://github.com/tarcisiooliveira2021/avatarizer-api
Last synced: 14 days ago
JSON representation
Avatarizer: Customização de avatares sensiveis ao contexto.
- Host: GitHub
- URL: https://github.com/tarcisiooliveira2021/avatarizer-api
- Owner: TarcisioOliveira2021
- Created: 2023-11-28T16:55:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-21T22:29:31.000Z (about 1 year ago)
- Last Synced: 2024-11-09T03:47:59.557Z (2 months ago)
- Language: Java
- Homepage:
- Size: 3.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Avatarizer
API REST que usa sensibilidade ao contexto para a customização de avatares.
## Versão
Avatarizer1.0
* Nesta versão a aplicação atende apenas o contexto climatologico brasileiro com as temperaturas váriando de 22 ~ 29 graus celsius.
## Como clonar o projeto ?
```
https://github.com/TarcisioOliveira2021/Avatarizer-API.git
```
## Como contribuir no projeto ?
Agradecemos o seu interesse em contribuir para o nosso projeto! Se você deseja fazer uma alteração ou adicionar um novo recurso, siga estes passos:
1. Crie um Fork do Projeto:
Faça um fork deste repositório para a sua própria conta no GitHub. Isso criará uma cópia do projeto que você pode modificar.
2. Realize as Alterações Propostas:
Faça as alterações necessárias no seu fork. Certifique-se de seguir as práticas recomendadas de codificação.
3. Solicite um Pull Request:
Quando estiver satisfeito com as suas alterações, envie um pull request. Estamos ansiosos para revisar suas contribuições!
4. Análise com Cuidado:
A nossa equipe analisará o seu pull request com atenção. Isso inclui verificar o código, testar as funcionalidades propostas e garantir que tudo esteja alinhado com os padrões do projeto.
5. Integração ao Projeto:
Se tudo estiver em ordem, estaremos felizes em integrar as suas alterações ao projeto principal. Agradecemos a sua colaboração!
## Documentação da API
A nossa API é documentada usando o padrão OpenAPI, e a documentação interativa pode ser acessada através do Swagger UI. Isso facilita a compreensão dos endpoints disponíveis, parâmetros, e respostas esperadas.
Para acessar a documentação da API, basta iniciar o servidor e visitar o seguinte URL:
- URL produção : *http://avatarizer-prod.up.railway.app/avatar/dados/*
- Exemplo de consulta completo: http://avatarizer-prod.up.railway.app/avatar/dados/A_001?latitude=-9.974&longitude=-67.8076
## Avatares base
| Código avatar | Avatar Base |
|---|---|
| A_001 |  |
| A_002 |  |
| A_003 |  |
| A_004 |  |
## Alterações de contexto
Nas imagens a seguir estão definidas as regras que estão definidas dentro do processador de contexto.
## Funcionamento
O Avatarizer funciona da seguinte maneira, durante a requisição feita do cliente para aplicação devem ser passados:
* Código do avatar base.
* Latitude do usuário.
* Longitude do usuário.
Após isso será o servidor do Avatarizer vai processar a requisição no "processador de contexto" que a partir da regras definidas vai devolver o avatar customizado.