Code Monkey home page Code Monkey logo

security-api's Introduction

Informações do Projeto

Para o funcionamento do projeto é necessário primeiro subir o ambiente KeyCloak Server e Redis e em seguida realizar a configuração do KeyCloak seguindo os passos deste LINK

Introdução

Este projeto é uma prova de conceito da utilização do KeyCloak como serviço de autenticação de usuários e o Redis como serviço para realizar o cache de informações.
A utilização de uma API Rest foi para facilitar a prova de conceito e demonstrar os procedimentos de salvar, atualizar, buscar e deletar entidades do banco de dados.

Técnologias utilizadas neste projeto

Spring Boot

O Spring Boot é um projeto da Spring que veio para facilitar o processo de configuração e publicação de nossas aplicações. A intenção é ter o seu projeto rodando o mais rápido possível e sem complicação.
Ele consegue isso favorecendo a convenção sobre a configuração. Basta que você diga pra ele quais módulos deseja utilizar (WEB, Template, Persistência, Segurança, etc.) que ele vai reconhecer e configurar.

Inicializador de projetos spring: Spring Initializr

Material para consulta e entendimento:

KeyCloak

O que é Keycloak?

Patrocinado pela Red Hat, o Keycloak é um software open source de um servidor JBoss feito para trabalhar em conjunto com sua aplicação em implementações mais comuns de autenticação e autorização. Caso as configurações padrão não te atendam, existem várias configurações e customizações que podem ser feitas para adequar o funcionamento ao seu sistema.

O que ele me oferece?

São oferecidas pelo Keycloak funcionalidades como:

  • Criação de usuário (podendo ser criados pelo administrador do sistema, e habilitado ou não para o próprio usuário se cadastrar);
  • Login, “esqueci minha senha”, login com plataformas externas como redes sociais;
  • Integração dos usuários com Active Directory;
  • Ativação de usuários por confirmação de e-mail;
  • Obrigar aceitação de termos de uso antes de logar;
  • Customização das páginas que o usuário acessa (como a própria tela de login);
  • Serviços para que outras aplicações busquem dados de usuários;
  • Criação de permissões que seu sistema vai usar;
  • Criação de grupos de usuário;
  • i18n (internationalization);
  • Entre outras várias configurações e customizações mais avançadas.

**Para utilizar o server do KeyCloak em conjunto com esta aplicação consultar o material disponível **AQUI (Env-DEV)****.

Material de apoio para consulta e entendimento:

Redis

O que é o Redis?

O Redis é um armazenamento de estrutura de dados de chave-valor de código aberto e na memória. O Redis oferece um conjunto de estruturas versáteis de dados na memória que permite a fácil criação de várias aplicações personalizadas. Os principais casos de uso do Redis incluem cache, gerenciamento de sessões, PUB/SUB e classificações.

Material de apoio e resolução de erros durante o aprendizado para consulta e entendimento:

Para utilizar o server do Redis em conjunto com esta aplicação consultar o material disponível AQUI (Env-DEV)

Lombok

O Lombok é um framework para Java que permite escrever código eliminando a verbosidade, o que permite ganhar tempo de desenvolvimento para o que realmente é importante. Seu uso permite gerar em tempo de compilação os métodos getters e setters, métodos construtores, padrão builder e muito mais.

Material para consulta e entendimento:

OpenAPI

A Especificação OpenAPI , originalmente conhecida como Especificação Swagger , é uma especificação para arquivos de interface legíveis por máquina para descrever, produzir, consumir e visualizar serviços da Web RESTful . Originalmente parte da estrutura Swagger , tornou-se um projeto separado em 2016, supervisionado pela OpenAPI Initiative, um projeto de colaboração de código aberto da Linux Foundation. Swagger e algumas outras ferramentas podem gerar código, documentação e casos de teste a partir de um arquivo de interface.

Material para consulta e entendimento:

Postman

Os testes da API podem ser feitos utilizando a documentação especificada no tópico abaixo ou utilizando o software Postman. Junto ao projeto foi disponibilizado uma collection para ser importado no software e assim poder realizar os testes com os endpoints especificiados.

Para importar seguir os seguintes passos:

  1. Fazer o download e instalar o Postman
  2. Abrir o Postman
  3. Clicar em file
  4. Clicar em import
  5. Arrastar e soltar o arquivo presenta na pasta "Postman/KeyCloak.postman_collection.json"
  6. Arrastar e soltar o arquivo presenta na pasta "Postman/Security API.postman_collection.json.json"

Para realizar os testes é necessário iniciar a aplicação keyCloak presente no material do tópico do KeyCloak e acessar a coleção do Postman para realizar o POST para salvar o token na variável global do postman. Após realizar os passos anteriores os demais endpoints irão utilizar desta variável global automáticamente

Documentação da API

Para visualizar a documentação da API rodar o código e acessar no navegador o link abaixo:

http://localhost:9001/security/v1/swagger-ui.html

Bibliotecas utilizadas

  • Mapear as entidades e Conectar ao banco de dados MongoDB - NoSQL.
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
  • Lombok cria os construtores , getteer e setters de forma automática.
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
    <scope>provided</scope>
</dependency>
  • Para montar a API Rest
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
  • Para documentar a API Rest
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.5.2</version>
</dependency>
  • Redis Cache
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
    <version>2.5.1</version>
</dependency>
  • Dependências do Data Redis
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>3.6.0</version>
</dependency>
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-pool2</artifactId>
    <version>2.10.0</version>
</dependency>

Referências utilizadas para produzir este projeto

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.