Intro

Well, after some years of working with OpenAPI and Spring Boot, I’ve seen that some experienced developers don't know this approach.

On my last projects, I used the OpenAPI specification to generate DTO objects and interfaces for RestControllers on Spring Boot, and the front-end team went with the OpenAPI specification to create objects and clients for API.

This article will explain how OpenAPI and Spring Boot work together to use API First Concept.

OpenAPI

On the official website:

The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.

The Open API Spec below contains POST, GET, PATCH, and DELETE requests/responses with Multipart and Path Params. So, it’s simple and easy to read, but Swagger Editor is simpler and is better to test/code.

An OpenAPI document that conforms to the OpenAPI Specification is itself a JSON object, which may be represented either in JSON or YAML format.

It might seem confusing at first, but given the declarative way of writing the spec in YAML it gets pretty straightforward and, most of all, very readable. Nevertheless, there are many tools for aiding in this process.

IMHO, the most important part is:

• Paths: Incremental (/v1/user before /v1/user/{id})
• Parameters (path, query, header, and cookies) and Request Body (JSON, multipart, etc)
• Components: The component’s definition with your properties, types, and formats. See the reference here.

Project Structure

In this example, the project structure is a parent pom with 2 modules: one for specification (openapi.yaml) and the other for implementation (of this specification), called impl.

OpenAPI Generator

To generate automatically DTOs objects and the Rest Interface, we can use the plugin openapi-generator-maven-plugin (to Gradle, use this plugin — thanks Aleksandar Stoisavljevic). An example of the POM using this plugin:

This definition will generate these classes:

On implementation, we add a dependency to this module.

<dependency>
    <groupId>io.xgeeks.demo.api</groupId>
    <artifactId>first-api-spec</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

In a perfect environment, this artefact will be pushed to an artefact manager like Nexus, JFrog, GitLab, Github…

Implementation

The signature of the REST methods is defined by the API spec itself. In my opinion, this is the best advantage to use OpenAPI to implement API First Approach from a back-end perspective using OpenAPI Generator. Let's see the UserApi interface (generated by OpenAPI Generator)

This is a way to keep the confidence of your spec between Front-end, Back-end, and thirty-party applications for example. Response, payload, parameters, mappings, everything is defined by OpenAPI. So, in my module implementation (first-api-impl), I just need to implement all the methods from the previously generated interface:

You can see and use my demo on my Github:

GitHub - mEstrazulas/demo-api-first: An API first application using Spring Boot and OpenAPI 3

And the Front End?

In my previous project, front-enders used an auto generator plugin for React to generate clients and types automatically. On this website, it is possible to check a list with a lot of client generators for multiple technologies and programming languages.

An API First approach gives front-enders the benefit to use a MockServer and the OpenAPI spec. while the backend part isn’t fully implemented for testing, allowing a faster pace this way.

GitHub - muonsoft/openapi-mock: OpenAPI mock server with random data generation

Auto-Generated Clients

Using a Swagger-Codegen plugin, it is possible to generate automatically clients in spec dependency. This will help communication between distributed systems using HTTP requests. In this article we will not cover this question, but here is the information.

Why using this approach and not others? (by Luis Nina)

In my opinion, this approach serves two main purposes: 1. helps back-enders define the proper methods to be implemented and for front-ends makes them advance in it’s own pace without the API fully implemented; 2. The other major purpose (not specific to this approach only but OpenAPI generally) is the fact that this kind of spec creates a contract between interested parties, teams can use a multitude of tools and technologies as long as they comply with the spec is all good.

Why using this approach and not others? (by Micael Vianna)

In addition to what Luis Nina commented, API First allows developers to think through the application better, negotiate with other teams before deploying, and not cause touchpoint waits.

References:

https://openapi-generator.tech/docs/generators/
https://editor.swagger.io/
https://swagger.io/docs/specification/about/
https://swagger.io/docs/specification/data-models/data-types/
https://github.com/mEstrazulas/demo-api-first
https://www.mock-server.com/mock_server/using_openapi.html
https://github.com/muonsoft/openapi-mock
https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin
https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen-maven-plugin/
https://www.baeldung.com/spring-boot-rest-client-swagger-codegen#1-maven-plugin

Special thanks to Luis Nina for suggestions and José Perdigão for corrections.

If you enjoy working on large-scale projects with global impact and if you like a real challenge, feel free to reach out to us at xgeeks! We are growing our team and you might be the next one to join this group of talented people 😉

Check out our social media channels if you want to get a sneak peek of life at xgeeks! See you soon!

API First, using OpenAPI and Spring Boot was originally published in xgeeks on Medium, where people are continuing the conversation by highlighting and responding to this story.

Contratação e Visto de Trabalho

Depois de um mês fazendo processos seletivos decidi por uma empresa que me pareceu mais amigável, mesmo a proposta sendo um pouco mais baixa que uma de uma enorme consultora daqui, mas que contratava com Recibos Verdes, com contrato de permanência de 24 meses. Preferia um pouco mais de segurança à ganhar alguns euros a mais.

Aceita a proposta, enviei meus dados digitalizados para a empresa, eles me enviaram via correio um contrato de promessa de trabalho (que devolvi assinado para a empresa uma das vias) e dei entrada no visto.

Todo o valor do visto, passagem, hospedagem inicial, tudo, por minha responsabilidade. A empresa só contratou a agência que agiliza a parte do visto. Já começa aí a ter de ter dinheiro e paciência. (Eu sei, existem empresas que pagam passagem, ajudam a procurar apartamento, mas não encontrei nenhuma dessas estando no Brasil).

Meu processo de visto, como falei, demorou 4 meses (e deveria ter demorado 30). Nesse tempo meu passaporte ficou retido no consulado. Atualmente estamos em pandemia, então, muitos processos de visto estão parados a mais de um ano. Se você pretende vir pra cá, se prepare. Há muita gente com processo paralizado por conta das restrições pandémicas, isso quer dizer:

• Muita gente tentando processo de visto
• Muita gente tentando resolver problemas junto ao SEF que não conseguiram na pandemia (estou a 7 meses tentando agendar o meu reagrupamento familiar, e nem contacto por telefone consigo) e muita gente tentando se regularizar. Tenham idéia do número de atendimentos crescente no sef

Em 5 de Setembro de 2019 cheguei a Lisboa e comecei a trabalhar na consultora dia 15. Tive 10 dias para procurar um quarto, conhecer um pouco da cidade e comprar coisas que havia deixado no Brasil.

Primeiro emprego, primeiras impressões

Como comentei acima, meu primeiro emprego cá em Portugal foi numa consultora qualquer. Não vou expor o nome, mas quem quiser saber pode ir no meu LinkedIn conferir.

Ao chegar, processo de onboarding normal, e já fui colocado em uma sala onde os novatos chegam. Chamava junto a um amigo de Recife recém chegado da Republica Checa esta sala de galinheiro. Era uma sala apertada, quente (o calor de Lisboa pode ser cruel) e normalmente cheia de brasileiros recém chegados ou de pessoas que estavam entre mudança de projetos.

Nesta sala a malta trabalha normalmente em projetos internos (testando coisas, projetos legados, projetos sem importancia, só para não ficar sem fazer nada) enquanto os managers tentam vender teu corpo para os clientes. Havia de tudo, devs Angular, React, Java, C#, PLSQL, iOS, Android, de tudo mesmo. A impressão que dá é que estas consultoras de outsourcing quando vêem um perfil razoavel e que aceite os termos, contratam e depois dão um jeito de tentar alocar em algum projeto.

Com meu perfil mais sênior e com experiencia em arquitetura, fui colocado em um projeto Nearshore de 3 meses de duração, com muita pressão, nada muito diferente do Brasil (levantava requisito, programava, escrevia documentação, participava de reunião, tudo por um salário de programador Junior). Enquanto isso, os managers disputavam meu adorável CV para me vender nos clientes que pagavam mais, cheguei a fazer 5 processos seletivos (sim, cada cliente tem seu processo seletivo para os outsourcings) em uma semana. Me sentia um produto, eles me pegavam, me levavam para uma empresa (ou outra consultora, pois aqui além de tercerização, temos quarteirização e quinteirização — imagine quanto que eles ganham em cima da sua alma), me vendiam, e se aceitassem, tocavam um SINO (SIM, eles comemoram tua venda!).

Depois de ver colegas de trabalho serem alocados em projetos péssimos e fui alocado em um projeto em um grande banco francês, e aí meus problemas começaram…

O Banco

Me venderam: Precisamos de um programador senior, que tenha experiência em microservices, melhoria de qualidade de código, definição de arquitetura, que possa trazer experiência e melhorias nos processos internos.

O produto: Projeto sem arquitetura de software definida, terrível manutenção, líder técnico incompetente (e não é birra), boicote ao meu trabalho, projeto não escalável, sem visibilidade alguma, código de péssima qualidade. O projeto tinha 1 ano e meio e era pior que legado de 10 anos que tive de trabalhar no Brasil! #socorro

No fim, passei 9 meses tentando demonstrar que o projeto era terrível, propus melhorias e nesse período não conseguimos fazer nenhuma release. 9 meses sem entregar nada ao cliente.

Nestes 9 meses estavamos a trabalhar em correções ou manutenção em código complexos que poderiam ser uma biblioteca já pronta na comunidade. O projeto demorava 15 minutos para subir localmente, se fazia integrações entre serviços usando REST com mais de 60mb de JSON passando de um lado para o outro, se reinventava a roda para tudo. Fingiam trabalhar com agile, um pesadelo.

Tudo é customizado, então, nada é customizado

Me desesperei e tentei melhorar o processo, tentei fazer mudanças, negociar, e aos poucos fui sendo barrado pelo líder técnico, no final, já fazia trabalho de estagiário (lembre, tenho 20 anos de experiência, vinha de um papel de arquiteto de microservices). Pedi a consultora diversas vezes para me tirar do projeto, mas eu era muito lucrativo pra eles lá.

Resultado? Estive a beira de um burnout, e ainda bem que fui trabalhar de home office por conta da pandemia. Quando completei 1 ano na na consultora (período do contrato), pedi demissão. Já tinha feito processo seletivo em uma empresa que um amigo me indicou e que é onde estou hoje, satisfeito. Na minha saída, outros 2 desenvolvedores sairam (eramos 3 mais o líder técnico… significa algo?).

Desligamento

Merece um capítulo a parte pois aqui há coisas importantes.

Primeiro, ao pedir desligamento, o Business Manager tentou me convencer a ficar, me fez temer ser demitido na nova empresa por conta da pandemia ou que podia ser um projeto horrível como o que estava, prometeu mundos e fundos, mas um aumento de salário prometido já não havia sido cumprido (e um bónus de €500 também estava a mais de 3 meses atrasado), a falta de apoio no problema que estava a ter no projeto e obviamente um salário mais atrativo (eles tentaram cobrir a oferta com 200 euros a menos). Ao não aceitar, mudou o tom, e disse que eu devia cumprir 60 dias de aviso prévio e que eles não iriam abrir mão disso e nunca mais falou comigo.

Ok, no problem. Enviei a carta de demissão para o CEO da empresa, que me ligou, dizendo:

Você só pensa em dinheiro, os Brasileiros são assim. Estou desapontado contigo. (meu caro, eu tenho contas a pagar, cumpri o 1 ano de contrato mesmo recebendo um salário abaixo do mercado para meu perfil, vocês não estão cumprindo o prometido, então, agora tchau!).

Cumpri os 60 dias e no fechamento de contas, não percebi que não me pagaram as horas de treinamento que por lei eu devo fazer (são treinamentos em horário laboral que devem ser feitos todo ano, se não fizer, eles devem pagar no fim do contrato). Perdi o dinheiro, mas, estava livre, legalizado e agora indo para um cliente final, não uma consultora.

Um detalhe importante: Muitas consultoras QUINTEIRIZAM os funcionários. Eles te levam a outra consultora, que te leva a outra consultora, que te coloca em um cliente. É a forma mais fácil de vir, é a forma que a maioria das pessoas conseguem contrato, mas fique de olhos abertos, há muita exploração nesse mercado.

Outra questão é:

Aprenda a dizer não

Sou programador backend e tentaram me vender para um cliente front-end, recusei. Eles tem muitas vagas e os managers querem te alocar o mais rápido possível para ligarem o taxímetro.

No próximo artigo pretendo falar sobre o novo emprego, os desafios na pandemia e o assédio de recruiters. Caso tenham dúvidas, deixem nos comentários.

Primeiro, o objetivo é falar um pouco da experiência que tenho tido no mercado, algumas dicas para imigração, alguns perrengues e cuidados que quem já está por aqui certamente já passou.

Segundo: Acho que isso vai ser uma série, então hoje vou abordar a questão da decisão de morar fora e o processo de entrevistas. Depois vou abordar a experiência de chegada, as impressões do mercado, assédio moral, assédio de outras empresas, qualidade de vida e o que achar que vale a pena.

Terceiro, me apresento: Trabalho com tecnologia desde 15 anos de idade, tenho mais de 20 anos de experiência com desenvolvimento, atualmente trabalhando com Java, Spring, Oracle, Microservices e mais um monte de coisa cult bacaninha. Já fui gerente, analista, líder técnico, arquiteto, full stack, front end, mobile developer, enfim, já fiz coisa pra caramba aqui.

Então, por que Portugal?

Se desejas mudar de país, pesquise, pesquise, e pesquise. Se estás aqui a procura de respostas prontas, não acho que seja o seu momento certo de emigrar. Gaste tempo para ler e ver material, e não veja apenas coisas boas do local, saiba dos problemas e das dificuldades.

Sempre cogitei morar fora do país, inclusive estive em vias de ir para a Austrália, mas meu sonho sempre foi o velho continente, principalmente Portugal. Mesmo idioma (apesar da língua ser bem diferente), cultura parecida (no RS há muita cultura Portuguesa), custo de vida mais baixo para quem vem de um país de terceiro mundo, facilidade de conseguir visto/trabalho, belezas naturais, história... Portugal é um país incrível.

Antes de decidir, me demitir e aceitar uma proposta, pesquisei sobre os hábitos, choque cultural, fiz simulações de compras em supermercados online, li sobre arrendamento de quartos/apartamentos (tema de um próximo texto), dificuldades de adaptação, enfim, a internet tem MUITO material sobre isso e sobre planejamento comento um ensinamento que mochilões me ensinaram:

Ao viajar, tudo o que planeou e ocorrer será economia e menos dor de cabeça. Imprevistos acontecem e os que não estiverem planeados só são resolvidos com dinheiro.

O Euro pra quem ganha em Real custa caro, aqui precisamos de reserva financeira, lembre-se: você não tem crédito, você está a renascer.

Conheço gente que desembarcou aqui com mulher e filho, sem conhecer nada, sem saber onde ia morar. Resultado? Alugou um Airbnb por € 1300 euros durante 20 dias e no desespero arrendou um apartamento por € 900 mensais (com salário de € 1300 coube torrar as reservas financeiras e ficar trazendo dinheiro do Brasil pra cá). Minha sugestão: Deixa o conjuge no Brasil por algumas semanas, organiza a vida, procura apartamento com calma, prepara o conforto, receba bem quem você quer bem.

Se por exemplo chegas cá e não sabes o que é um PB4 e precisas de atendimento hospitalar, prepare-se para arcar com isso. Pelo menos € 300 euros uma consulta particular, então, PLANEIE. Leia sobre saúde, segurança social, transportes, moradia, alimentação.

A Decisão

Foram 2 anos para decidir pedir demissão na empresa, a primeira coisa foi pesquisar sobre o processo de visto, documentos necessários, preparar tudo. Pedi demissão antes de ter proposta, pois queria um tempo de descanso (que se mostrou maior que o necessário — meu visto demorou 4 meses para ser aceito, e isso que não deu problemas, tenho conhecidos que demoraram 6 meses).

Então vamos lá: Renovei meu passaporte, apostilei (se não sabe o que é isso está na hora de começar a pesquisar) outros tantos, comecei a juntar dinheiro (sim, você vai precisar muito disso), assistia TV portuguesa para captar o idioma, pesquisei custo de vida (simule compras nos supermercados online, pesquise preço de alugueis, transportes… Tenha noção dos salários em Portugal (o Teamlyzer tem uma ferramenta que ajuda a ter criterio e não ser um sem noção , mas lembre-se, você vem de outro país. Eles sabem que você quer sair daí de qualquer forma, então não espere receber o mesmo que alguém que já cá está).

Então, depois de alguns meses, tomei coragem e pedi para me demitirem. Fiz um acordo com a empresa e depois de 51 dias de aviso prévio estava livre. Comecei então a participar de processos seletivos…

Entrevistas e mais entrevistas

No início enviava diversos currículos pelo Linkedin (sim, aqui é muito usado) e não recebia retorno, procurava normalmente vagas em cliente final, tentava fugir do outsourcing, mas se você não tem documentação, provavelmente virá por uma consultora (empresas de outsourcing). Outra questão é: faça seu currículo no padrão Europass (mesmo que depois tenha de preencher o currículo no padrão da empresa que vai te entrevistar).

Busquei por empresas que estavam no programa Techvisa. O Techvisa é um tipo de visto específico para profissionais altamente qualificados, então as empresas que estão neste programa recebem incentivos para trazer profissionais de fora, contam com “agilidade” no processo de vistos e possuem regras (um salário mínimo — que também é a média inicial — para este tipo de vaga, acho que em torno de € 1335).

Então, comecei a participar de entrevistas, foram muitas, e prepare-se: o processo de contratação costuma ser lento e cheio de fases. E sim, as entrevistas acontecem em horário local de Portugal, então tive diversas entrevistas as 4 da manhã. Outra coisa importante, treine seu inglês. Normalmente são questões simples, mas o inglês é muito importante e nós brasileiros por norma, não temos prática do idioma.

Normalmente os processos são 4 passos:

1. Recruiter (bate papo para saber seu perfil)
2. Técnica (possibilidade de aplicação de teste)
3. Business Manager (entrevista um pouco menos técnica, explicação da empresa, idiomas, etc)
4. Apresentação de proposta

A questão da proposta pode conter algumas questões que devem ser levadas em conta:

Existem dois tipo de contratação, contrato sem termo, é como se fosse CLT e vens com o visto D3 e recibos verdes, que é como se fosse o PJ do Brasil e virá com visto de empreendedor, o D2. Normalmente o recibo verde atrai, tens um salário liquido maior, mas tens de ficar atento pois há impostos a serem pago, há descontos no IRS no primeiro e mais detalhes que não sei, então, vale a pena falar com um contador.

Outra cena MUITO importante, as empresas normalmente patrocinam o seu processo de visto. Eles contratam uma empresa para cuidar da tua documentação. Normalmente o que eles fazem é realizar os agendamentos, te acompanhar na legalização aqui, e, nada é de graça. Então eles colocam no contrato de trabalho uma cláusula de permanência, no meu caso foi de 12 meses, caso saia antes (o mercado é muito tentador), tens de pagar uma multa. No entanto, CUIDE, há empresas que colocam cláusulas de 24 meses com multas de € 10.000. Possivelmente ilegal, mas, se a empresa tenta te sacanear antes de assinar o contrato, imagine depois, então, 👀 .

Bom malta, semana que vem coloco a continuação deste artigo. Qualquer coisa, deixa um comentário :)