BFF (Backends For Frontends) desenvolvido em Spring Boot que efeuta o acesso as API´s Oficiais da Marvel e busca o personagem, HQ´s e eventos de acordo com o nome pesquisado.
aws - arquivos relacionados a implantação no ambiente da AWS ou LocalStack
bff-marvel - API desenvolvida em Spring Boot
swagger - Swagger da API da Marvel
Efetuar o cadastro no portal para obter as chaves e acesso a API da Marvel:
Será necessário gerar um hash com as chaves da API da Marvel para efetuar as chamadas. Na documentação do Portal da Marvel existe a explicação. Sugestão de site que gera hash MD5:
Baixar o Swagger do site abaixo:
Com o Swagger, gerar o código da aplicação através dos seguintes comandos:
wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.29/swagger-codegen-cli-3.0.29.jar -O swagger-codegen-cli.jar
java -jar swagger-codegen-cli.jar generate -i marvel-public-api-v1-swagger.json -l spring --library spring-cloud -o marvel- bff-marvel: aplicação Maven multi-module com as chamadas da API da Marvel
- marvel: exemplo de código gerado a partir do Swagger da API da Marvel
Efetuando a pesquisa a partir de um nome de herói:
curl --location --request GET 'http://localhost:8080/marvel/heroes/iron man'A resposta da chamada retorna por enquanto 20 registros de HQ´s e eventos:
[
{
"id": 1009368,
"name": "Iron Man",
"description": "Wounded, captured and forced to build a weapon by his enemies, billionaire industrialist Tony Stark instead created an advanced suit of armor to save his life and escape captivity. Now with a new outlook on life, Tony uses his money and intelligence to make the world a safer, better place as Iron Man.",
"comics": [
{
"title": "Death Of Doctor Strange: Avengers (2021) #1",
"issueNumber": 1
},
{
"title": "Shang-Chi (2021) #5",
"issueNumber": 5
},
{
"title": "Iron Man (2020) #13",
"issueNumber": 13
},
{
"title": "The Darkhold: Iron Man (2021) #1",
"issueNumber": 1
},
{
"title": "Dark Ages (2021) #2",
"issueNumber": 2
},
{
"title": "Infinite Destinies (Trade Paperback)",
"issueNumber": 0
},
{
"title": "Dark Ages (2021) #1",
"issueNumber": 1
},
{
"title": "Giant-Size Little Marvels Infinity Comic (2021) #2",
"issueNumber": 2
},
{
"title": "Avengers Annual (2021) #1",
"issueNumber": 1
},
{
"title": "Iron Man (2020) #11",
"issueNumber": 11
},
{
"title": "Daredevil (2019) #32",
"issueNumber": 32
},
{
"title": "Iron Man (2020) #10",
"issueNumber": 10
},
{
"title": "Iron Man (2020) #9",
"issueNumber": 9
},
{
"title": "Iron Man Annual (2021) #1",
"issueNumber": 1
},
{
"title": "Iron Man (2020) #8",
"issueNumber": 8
},
{
"title": "Man-Thing by Steve Gerber: The Complete Collection Vol. 3 (Trade Paperback)",
"issueNumber": 0
},
{
"title": "Iron Man (2020) #7",
"issueNumber": 7
},
{
"title": "Iron Man (2020) #6",
"issueNumber": 6
},
{
"title": "Iron Man (2020) #5",
"issueNumber": 5
},
{
"title": "King In Black: Iron Man/Doom (2020) #1",
"issueNumber": 1
}
],
"events": [
{
"title": "Acts of Vengeance!",
"description": "Loki sets about convincing the super-villains of Earth to attack heroes other than those they normally fight in an attempt to destroy the Avengers to absolve his guilt over inadvertently creating the team in the first place."
},
{
"title": "Age of X",
"description": "In a strange reality where the X-Men never came to be, the war between humans and mutants has escalated to a level never before seen. What has become of our heroes and who will survive as the final war commences?"
},
{
"title": "Armor Wars",
"description": "Tony Stark discovers that someone has been stealing his Iron Man tech and selling it to supervillains. He decides he must do whatever it takes to reacquire -- or destroy -- the stolen tech."
},
{
"title": "Atlantis Attacks",
"description": "Ghaur returns to complete his quest to resurrect the evil god Set, but his plan is opposed by Earth's heroes."
},
{
"title": "Avengers Disassembled",
"description": "Writer Brian Michael Bendis kicks off his historic run with the Avengers by bringing the previous era to a close alongside artist David Finch! Chaos reigns when of Earth’s Mightiest Heroes turns against their teammates, leading the Avengers into a battle that not all will survive! Featuring Iron Man, Captain America, Hawkeye, the Scarlet Witch and more!"
},
{
"title": "Avengers VS X-Men",
"description": "A 12-issue event written by the unprecedented team of Brian Michael Bendis, Jason Aaron, Jonathan Hickman, Ed Brubaker and Matt Fraction with art by the blockbuster trio of John Romita Jr., Olivier Coipel and Adam Kubert, Avengers VS X-Men brings Marvel's biggest characters up against the greatest threat they've ever faced: each other!"
},
{
"title": "Chaos War",
"description": "When the Chaos King embarks on a campaign to wipe out all of existence, Hercules gathers the God Squad to stand in his way! Writers Greg Pak and Fred Van Lente join artist Khoi Pham to pit Herc and his rag tag team—including Thor, the Silver Surfer and Amadeus Cho—against an all-powerful evil as dead heroes and villains rise around them!"
},
{
"title": "Civil War",
"description": "After a horrific tragedy raises questions on whether or not super heroes should register with the government, longtime Avengers teammates Captain America and Iron Man end up on opposite sides of the argument! Writer Mark Millar and artist Steve McNiven split the Marvel Universe in two as friend fights friend in one of the most celebrated and successful events of all-time!"
},
{
"title": "Crossing",
"description": "Iron Man betrays the Avengers to Kang at the cost of several lives, ultimately including his own."
},
{
"title": "Dark Reign",
"description": "Norman Osborn came out the hero of Secret Invasion, and now the former Green Goblin has been handed control of the Marvel Universe. With his Cabal and the Dark Avengers at his side, can anything stop this long time villain from reshaping the world in his own image? And what has become of the heroes?"
},
{
"title": "Enemy of the State",
"description": "HYDRA, the Hand and a mutant group known as the Dawn of the White Light formed an alliance the purpose of which was to kill and resurrect superheroes under their control, starting with Wolverine. The alliance used Wolverine for various missions until he was recovered by S.H.I.E.L.D. and deprogrammed. Wolverine vowed to dismantle HYDRA and the Hand for what they did to him and for what they made him do."
},
{
"title": "Fatal Attractions",
"description": "Magneto returns, more powerful than ever, and Professor X realizes it's time for their decades-long conflict to end, permanently. Professor X and Magneto square off against each other aboard Asteroid M and after Magneto strips Wolverine of his adamantium Professor X destroys Magneto's mind. Colussus stays behind to care for Magneto since he has now defected to the Acolytes."
},
{
"title": "Fear Itself",
"description": "The Serpent, God of Fear and brother to the Allfather Odin, rises to challenge Earth’s Mightiest in a seven-issue event written by Matt Fraction with art by Stuart Immonen! As the Worthy, heralds of the Serpent, lay waste to the Marvel Universe, how can Thor, Captain America, Iron Man and the Avengers turn back the tide of fear?"
},
{
"title": "House of M",
"description": "When the Scarlet Witch alters reality, the Avengers and X-Men face a world like none they’ve ever known! Writer Brian Michael Bendis and artist Olivier Coipel re-imagine the Marvel Universe with Magneto bringing mutantkind to prominence in an eight-issue event. As the only person who remembers how things used to be, can Wolverine set things right? Should he?"
},
{
"title": "Infinity",
"description": "While the most powerful Avengers journey into outer space in an attempt to unite the universe against the Builders, Thanos attacks the Earth in a six-issue event written by Jonathan Hickman with the art of Jim Cheung, Jerome Opena and Dustin Weaver! Featuring the Guardians of the Galaxy, the Inhumans and many more!"
},
{
"title": "Infinity War",
"description": "The Magus, the purged, evil side of Adam Warlock believed to have been dead, has returned in order to collect the Infinity Gems and recreate the Infinity Gauntlet itself. He sent evil doppelgangers of Marvel's superheroes to attack and usurp the originals. Thanos, exiled since his defeat during the Infinity Gauntlet event, learned of the Magus' plans and set out to aid Adam Warlock and the heroes in defending the universe."
},
{
"title": "Inhumanity",
"description": "Following Infinity, the actions of Black Bolt have affected not only his people, but the entire Marvel Universe, as a new race of Inhumans rises up! Witness change for every major Marvel character, led by Inhuman, a new series from Matt Fraction and Joe Madureira!"
},
{
"title": "Initiative",
"description": "After the partial destruction of Stamford, CT, the United States federal government enacted the Superhero Registration Act, a law designed to monitor, regulate, train and coordinate America's superheroes. The Initiative was an outgrowth of the SHRA, created by Tony Stark, the purpose of which was to place standby superhero teams in all 50 states."
},
{
"title": "Maximum Security",
"description": "At a meeting of the Shi'Ar intergalactic council, after numerous races lodge complaints against humanity, it is decided that Earth will become a prison planet. Unfortunately, one of the prisoners sentenced to Earth is Ego the Living Planet, who proceeds to expand exponentially, threatening the entire planet. It is soon discovered that one of the complaining races, the Ruul, are the Kree, whose Supreme Intelligence evolved them using the Destiny Crystal and manipulated the council to destroy Earth's heroes!"
},
{
"title": "Onslaught",
"description": "The evil within Professor Charles Xavier combines with the power of Magneto to create Onslaught, perhaps the greatest threat ever to the Marvel Universe! It begins with the X-Men, but before the end, the Avengers, the Fantastic Four and the rest of Earth's greatest heroes will know sacrifice before victory!"
}
]
}
]Use o comando abaixo para gerar a imagem Docker:
mvn spring-boot:build-image -Dspring-boot.build-image.imageName=bff-marvel-api:1.0.0
Executando a imagem com LocalStack
docker run -e "SPRING_PROFILES_ACTIVE=localstack" -e "AWS_ACCESS_KEY_ID=localstack" -e "AWS_SECRET_KEY=localstack" -e "AWS_REGION=sa-east-1" -p 8080:8080 bff-marvel-api:1.0.0
Executando a imagem em Produção
docker run -e "SPRING_PROFILES_ACTIVE=production" -e "AWS_ACCESS_KEY_ID=production" -e "AWS_SECRET_KEY=production" -e "AWS_REGION=sa-east-1" -p 8080:8080 bff-marvel-api:1.0.0
Para usar o LocalStack no AWS Secret Manager e no AWS Parameter Store usar as seguintes configurações:
aws:
secretsmanager:
enabled: true
endpoint: http://host.docker.internal:4566
paramstore:
enabled: true
endpoint: http://host.docker.internal:4566
Ainda não está funcionando corretamente!!!
Para funcionar a escrita e leitura de arquivos usando S3 com LocalStack o endpoint deve ser configurado da seguinte forma:
cloud:
aws:
s3:
endpoint: http://s3.localhost.localstack.cloud:4566/
Usando o AWS Secret Manager em uma aplicação Spring Boot com Spring Cloud AWS.
Para habilitar o LocalStack, usar o seguinte profile:
-Dspring.profiles.active=localstack
Para execução com o LocalStack é necessário mudar o endpoint do Secret Manager no arquivo bootstrap.yml para o endereço do LocalStack:
aws:
secretsmanager:
endpoint: http://localhost:4566
Além disso a região padrão deve ser sempre us-east-1 para testar com LocalStack.
Crie um profile separado com o AWS Cli:
aws configure --profile localstack
AWS Access Key ID [None]: test
AWS Secret Access Key [None]: test
Default region name [None]: us-east-1
Default output format [None]:
Na criação das chaves do Secret Manager incluir o paramêtro --profile
aws --endpoint http://localhost:4566 --profile localstack secretsmanager create-secret --name /secret/bff-marvel-api_localstack --description "Segredos para acesso a API da Marvel" --secret-string "{\"ts\":\"x\",\"apiKey\":\"x\",\"hash\":\"x\"}"
Comandos para criação das chaves usando o AWS Cli estão localizadas no diretório scripts.
3.4. Integrating your Spring Cloud application with the AWS Secrets Manager
As instruções são a mesma utilizadas na seção anterior do AWS Secret Manager, diferenciando somentes os comandos do AWS Cli para criação dos paramêtros que estão localizadas no diretório scripts.
A aplicação do Spring Boot pega automaticamente as credenciais no arquivo ~/.aws/credentials e conecta nos serviços da AWS.
O usuário configurado deve possuir as permissões para acessar os recursos da AWS.
-
2022-02-06
- Criando um profile de produção
-
2022-02-03
- Docker
- Incluindo a geração da imagem e conexão com alguns serviços básicos do LocalStack
- Docker
-
2022-02-02
- Async Spring Boot
- Incluíndo o Async para obter as imagens dos personagens
- Arquitetura Hexagonal
- Refatoração do Client da API da Marvel
- Async Spring Boot
-
2022-02-01
- Arquitetura Hexagonal
- Modelo inicial
- AWS
- Gravando as imagens dos personagens no S3 com LocalStack
- Arquitetura Hexagonal
-
2022-01-31
- Configuração Distribuida
- AWS Secret Manager com LocalStack
- AWS Parameter Store com LocalStack
- AWS
- AWS Secret Manager com LocalStack
- AWS Parameter Store com LocalStack
- Configuração Distribuida
- Spring Data - gravar as informações obtidas dentro de um banco de dados NoSQL
- Observability:
- Kiali
- Jaeger
- Tratamento de Erros:
- RestControllerAdvice
- Log com Trace Id
- Erros do FeignClient
- Cache
- Docker Hub
- gRPC
- Integração com Frontend
- CI/CD
- Cobertura de Testes Unitários e Integrados
- Exemplos de Controller
- POST - Buscar uma lista de personagens e incluir novos personagens
- PUT - Atualizar um personagem
- DELETE - Excluir um personagem
- Refatoração do Código
- Autenticação e Autorização
- Keycloack
Thomás da Costa - https://thomasdacosta.com.br