Cinemas API

Sobre o Repo

API de cinemas e filmes criada no curso da Alura de .NETs, na formação ASP.NET Core REST APIs, dentro do meu processo de aprendizado e prática dessa plataforma. Da forma que foi construída, a API pode ser utilizada sem necessidade de forte acoplamento com estruturas MVC, que podem acabar com responsabilidades demais quando não utilizam de API's. O arquivo .gitignore foi gerado automaticament utilizando do comando "dotnet new gitignore".

Documentação

Os endpoints podem ser facilmente visualizados e consultados utilizando a URL que os exibe tratados no formato do Swagger.

Configuração

Banco de Dados

Dentro da pasta da solução FilmesAPI, contém um arquivo appsettings.example.json, que pode ser utilizado para definir as string de conexão, sendo a principal para MySQL. Ao remover o sufixo ".example", o arquivo não será considerado pelo git, pois ficará com suas configurações pessoais.

As credenciais para uso de banco de dados com o projeto UsuariosAPI, podem ser as mesmas utilizados na FilmesAPI, mas com a base sendo db_usuarios ao invés de db_filmes por padrão.

Recomenda-se manter os bancos de dados separados e com a nomeação que vêm de configuração, mas fica a critério do utilizador da aplicação, não sendo um critério para funcionamento.

Para o projeto escolhido, apenas utilize o Console do Gerenciador de Pacotes (em caso de utilizar o Visual Studio) e rode o comando Update-Database, ou entre no diretório do projeto e rode o comando dotnet ef database update.

Como, para o projeto UsuariosAPI, algumas credenciais são necessárias e a equipe de desenvolvimento responsável não quis deixar valores padrão e previsíveis, também foram definidas strings de configuração para o usuário default admin, que pode realizar todas as operações em todos os Endpoints da FilmesAPI. Antes de construir o banco de dados com o comando já citado, adicione essas credenciais no arquivo de configurações e crie o banco de dados com o comando dotnet ef migrations add NomeDaMigracao (ou Add-Migration NomeDaMigracao, para o caso de utilizar Visual Studio) e aí sim construa o banco de usuários.

E-mail

Para que o client de e-mail funcione corretamente na aplicação, também deve-se configurar suas credenciais para endereço e senha no nó "EmailSettings" do appsettings.json.

A fim de oferecer maior suporte e ofecer facilidade para os utilizadores da aplicação, escolheu-se o "Gmail" como client principal, mas isso também pode ser facilmente alterado.

Em casos em que a conta tem a opção de Autenticação Por Dois Fatores habilitada, a senha pessoal não funcionará como forma de autenticação, sendo necessário gerar uma senha específica para o dispositivo. Maiores informações sobre esse processo pode ser encontrada na documentação do serviço.

Estrutura do Banco de Dados

O banco de dados é relativamente simples, contendo apenas algumas entidades e a tabela de migrações criada pelo framework (que, intencionalmente, não aparecerá no diagrama).

Modelo construído utilizando as ferramentas nativas do MySQL Workbench

Futuras Implementações

• Documentar as classes e métodos;
• Tornar métodos assíncronos onde for necessário;
• Alterar o banco de dados para que gêneros de filme seja uma entidade à parte com um relacionamento n:n com filmes;
• Alterar ids das chaves primárias de inteiros com autoincrement para uuid ou identificações mais aleatórias e únicas;
• Utilizar conversão de HTML para o corpo do e-mail e tornar mais visualmente agradável;
• Hospedar a API.

Atualizações

Versão 1.2.1:

A versão 1.2.1 reverte os modificadores de acesso para public, já que quando ficam como internal, o Entity não consegue montar os endpoints.