<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Jorge Souza on Medium]]></title>
        <description><![CDATA[Stories by Jorge Souza on Medium]]></description>
        <link>https://medium.com/@jorge-souza?source=rss-6d2c3ba23dc9------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/0*EjUjnE-Y37RePHTO.jpg</url>
            <title>Stories by Jorge Souza on Medium</title>
            <link>https://medium.com/@jorge-souza?source=rss-6d2c3ba23dc9------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Sat, 21 Nov 2026 13:12:50 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@jorge-souza/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[Kotlin com Spring Boot: API REST]]></title>
            <link>https://medium.com/@jorge-souza/kotlin-com-spring-boot-api-rest-e13890bcb1e7?source=rss-6d2c3ba23dc9------2</link>
            <guid isPermaLink="false">https://medium.com/p/e13890bcb1e7</guid>
            <category><![CDATA[spring-boot]]></category>
            <category><![CDATA[rest]]></category>
            <category><![CDATA[kotlin]]></category>
            <dc:creator><![CDATA[Jorge Souza]]></dc:creator>
            <pubDate>Tue, 30 Nov 2021 13:00:30 GMT</pubDate>
            <atom:updated>2021-11-30T14:10:00.659Z</atom:updated>
            <content:encoded><![CDATA[<blockquote>Construir aplicações com <a href="https://spring.io/projects/spring-boot">Spring Boot</a> precisam de um mínimo de configuração e por isso é bastante produtivo, tornando a curva de aprendizado simples e ganhando com isso grande adoção. <a href="https://kotlinlang.org/">Kotlin</a> por sua vez é uma linguagem que roda na JVM e foi criada pela JetBrains, empresa detentora de várias IDE’S como a própria Intellij que vamos utilizar neste projeto.</blockquote><h4><strong>REST:</strong></h4><p>De maneira geral, REST (<strong><em>RE</em></strong><em>presentational </em><strong><em>S</em></strong><em>tate </em><strong><em>T</em></strong><em>ransfer — Transferência de Estado Representacional</em>) é um modelo arquitetural para integração de sistemas. É um guia com princípios que devemos seguir para termos uma api de alto nível. Martin Fowler explica em detalhes quais são esses princípios em seu artigo: <a href="https://martinfowler.com/articles/richardsonMaturityModel.html">Richardson Maturity Model: steps toward the glory of REST</a>.</p><h4>Configurando e iniciando o projeto:</h4><p>Para fins didáticos, o projeto construído será uma <strong>API para cadastro de Categorias</strong> com operações de <strong>consulta (incluindo filtros, paginação e ordenação), cadastro, atualização e remoção</strong>. Servirá como base para iniciar a implementação de qualquer API, basta adotar o seu escopo. O código completo está disponível no <a href="https://github.com/jorgesouza/bootstrap-api">Github</a>.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/500/1*9US74jRtPv5NBD-t-z7OFw@2x.jpeg" /><figcaption>Kotlin + Spring Boot + PostgreSQL</figcaption></figure><p>Dentre as tecnologias e ferramentas, iremos utilizar:</p><ul><li><a href="https://www.jetbrains.com/idea/download/">IntelliJ IDEA (Community Edition)</a></li><li><a href="https://spring.io/projects/spring-boot">Spring Boot</a> (2.2.6)</li><li><a href="https://kotlinlang.org/">Kotlin</a></li><li><a href="https://gradle.org/">Gradle</a></li><li><a href="https://www.enterprisedb.com/downloads/postgres-postgresql-downloads">PostgreSQL</a></li><li><a href="https://spring.io/projects/spring-data-jpa">Spring Data JPA</a> (módulo para integração com banco de dados)</li><li><a href="https://flywaydb.org/">Flyway</a> (migração e versionamento dos scripts do banco de dados)</li><li><a href="https://www.postman.com/downloads/">Postman</a> (para testar nossa API)</li></ul><p>Com o intuito de otimizar o tempo gasto nas configurações iniciais do projeto, a <a href="https://pivotal.io/"><strong>Pivotal Software</strong></a> criou um bootstrap que elimina a etapa repetitiva de todo e qualquer novo projeto. Trata-se do <a href="https://start.spring.io/"><strong>Spring Initializr</strong></a>, um bootstrap para aplicações Spring.</p><p>No site, escolha Gradle Project, Kotlin e, inicialmente, a dependência do Spring Web apenas (posteiormente vamos adicionar outras diretamente no projeto). Depois clique em <strong>Generate</strong> para baixar o projeto inicial.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*PZ41BV8p3EIVmQV0yIC3YQ.png" /><figcaption>Spring Initializr — <a href="https://start.spring.io/">https://start.spring.io/</a></figcaption></figure><p>Descompacte e importe no IntelliJ.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/811/1*XBz8ydKwEjDgNCVjH_3O1w.png" /><figcaption>IntelliJ IDEA (Community Edition)</figcaption></figure><p>Na primeira vez que você realizar essa etapa provavelmente irá demorar um pouco, pois todas as dependências serão baixadas pelo Gradle, incluindo as do Core do Spring.</p><p>A classe responsável por iniciar nosso projeto é a <strong>BootstrapApiApplication</strong>. Ao executá-la o Spring roda um Tomcat embutido na porta 8080 (isso é configurável caso necessário, tanto a porta quanto o server) e sobe a aplicação.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/cbf2a14c61ca350d0ab23edc4d1f8aba/href">https://medium.com/media/cbf2a14c61ca350d0ab23edc4d1f8aba/href</a></iframe><h4>RestController:</h4><p>Para testarmos que está tudo certo, vamos criar um simples controller para receber nossa requisição:</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/42c40986524afebd44758762be4a355b/href">https://medium.com/media/42c40986524afebd44758762be4a355b/href</a></iframe><p><strong>@RestController </strong>serve para indicar ao Spring que nosso Controller é do tipo REST, uma versão especializada de controlador que inclui as anotações <strong>@ResponseBody</strong> e o <strong>@Controller</strong> para a classe.</p><p>Aqui podemos ver uma das características do Kotlin, inferindo o tipo de retorno em funções com uma expressão no corpo. Não temos inclusive a necessidade de colocar o código entre chaves.</p><p>Agora iniciamos a aplicação executando a classe <strong>BootstrapApiApplication</strong>.</p><p>No Postman basta realizar uma requisição em <a href="http://localhost:8080/hello-world">http://localhost:8080/hello-world</a> e teremos o resultado abaixo.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*WcOe6RPS86kQuhaWgy6eFw.png" /><figcaption>Hello World — Postman</figcaption></figure><h4>Spring Data JPA com PostgreSQL:</h4><p>Spring Data JPA é um framework dentro do ecossistema Spring que abstrai toda complexidade de integração com banco de dados, ou seja, nossa camada de persistência. Tem como principal objetivo nos auxiliar na criação de repositórios de forma produtiva e automatizada.</p><p>Para utilizarmos em nosso projeto, basta adicionarmos a dependência do Spring Data JPA e PostgreSQL Driver em nosso arquivo de configuração <strong>build.gradle.kts</strong>.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/baca24d1d4c2c5aa5f083afe4a25a191/href">https://medium.com/media/baca24d1d4c2c5aa5f083afe4a25a191/href</a></iframe><p>E, no arquivo <strong>application.properties </strong>no path <strong>resources</strong>, vamos adicionar as propriedades para conexão com o banco PostgreSQL.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/04eebc346536a0d0a105ed2b63c6c4b8/href">https://medium.com/media/04eebc346536a0d0a105ed2b63c6c4b8/href</a></iframe><blockquote><a href="https://www.enterprisedb.com/downloads/postgres-postgresql-downloads">Instale o postgres</a> ou caso possua Docker, execute: docker run --name bootstrapapi -p 5432:5432 -e POSTGRES_PASSWORD=postgres -d postgres</blockquote><h4>Flyway Database Migrations:</h4><p>Para adicionarmos em nosso projeto, basta adicionarmos a dependência no <strong>build.gradle.kts</strong>.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/c6db4636d44cf0d94181676b28c15532/href">https://medium.com/media/c6db4636d44cf0d94181676b28c15532/href</a></iframe><p>É no path <strong>resources/db/migration </strong>que o Flyway procura pelas migrações, então vamos criar o arquivo <strong>V01__create_table_categories.sql </strong>e adicionar neste path. O padrão de nomenclatura do arquivo seque o modelo acima, sendo “V[<em>versao</em>]__[<em>description</em>].sql”.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/30193925e2ecb33bae8642c30fa41d73/href">https://medium.com/media/30193925e2ecb33bae8642c30fa41d73/href</a></iframe><p>Ao executar nossa aplicação, o Spring Boot executará as migrações através do Flyway. Também será criada uma tabela que mantém o histórico das migrações chamada <strong>flyway_schema_history</strong>.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*VdDr0DYCDRqXSim4jyknuQ.png" /><figcaption>select * from flyway_schema_history;</figcaption></figure><h4>Criando nossa entidade:</h4><p>Vamos também criar nossa entidade Category, responsável por representar nossa tabela categories no banco de dados.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/060130d6ed16b836a6ca0601e33ae2c0/href">https://medium.com/media/060130d6ed16b836a6ca0601e33ae2c0/href</a></iframe><h4>Utilizando o padrão DTO (Data Transfer Object)</h4><p>O padrão DTO (Data Transfer Object) serve para trafergarmos de maneira segura apenas o necessário para a camada que expões os dados da API, ou seja, tem a finalidade de não expor todo e qualquer atributo a camada mais externa da nossa API. Ele irá servir tanto para entrada da requisição quanto para resposta da requisição.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/1d6ab33e850dc2571944278d6e849bcf/href">https://medium.com/media/1d6ab33e850dc2571944278d6e849bcf/href</a></iframe><p>Podemos fazer uso também das <a href="https://kotlinlang.org/docs/reference/extensions.html">Extension Functions</a> do Kotlin para criar um conversor para entidade de forma produtiva.</p><h4>Validando com Bean Validation:</h4><p>Para fazermos uso do Bean Validation, temos que adicionar em nosso método no RestController a anotação <strong>@Valid</strong>. Existem diversos tipos de validações disponíveis, dentre elas vamos utilizar:</p><p><strong>@field:NotNull</strong> é uma anotação para validação em caso do atributo ser nulo. Pode ser utilizado em qualquer tipo. Utilizado em conjunto com Bean Validation.</p><p><strong>@field:Size</strong> é uma anotação para validação se o tamanho do elemento está entre os limites especificados. Também utilizado em conjunto com Bean Validation.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/91e9864c03b2d78070c98b81691d8a8b/href">https://medium.com/media/91e9864c03b2d78070c98b81691d8a8b/href</a></iframe><p>Podemos também customizar a mensagem de retorno. Basta criarmos um arquivo chamado <strong>ValidationMessages.properties</strong> em nosso path <strong>resources</strong>:</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/6ab8144d3aef757763be9cec1710550a/href">https://medium.com/media/6ab8144d3aef757763be9cec1710550a/href</a></iframe><h4>RestController Category e camada service:</h4><p>Agora, vamos criar nosso primeiro recurso REST para gerenciar categorias:</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/a9cab14141ee021dcc09652801682d81/href">https://medium.com/media/a9cab14141ee021dcc09652801682d81/href</a></iframe><p>E como você pode ver, temos também uma classe que será nossa Service, ou seja, conterá a regra de negócio e comunicação com o repository:</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/f667e148f9d5eb5bddd96192626b7888/href">https://medium.com/media/f667e148f9d5eb5bddd96192626b7888/href</a></iframe><p><strong>@Service:</strong> anotação para indicar nossa camada de serviço, onde conterá nossa lógica de negócio.</p><h4>Utilizando o padrão Repository:</h4><p>A interface JpaRepository já nos dá vários métodos prontos que podemos utilizar aumentando nossa produtividade. Por exemplo, para várias operações simples no banco de dados para salvar, consultar, atualizar e deletar, dentre outras, já estarão disponíveis por estarmos utilizando o Spring Data JPA.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/68e34bcda2715e85b7427bd9c08e1949/href">https://medium.com/media/68e34bcda2715e85b7427bd9c08e1949/href</a></iframe><p>Também é possível construir nossos próprios métodos, como exemplo: <strong>findByNameIgnoreCase</strong>. A nomenclatura segue um padrão de acordo com a entidade criada. <a href="https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation">Você pode ver mais possibilidade na própria documentação.</a></p><h4>Inserindo dados com POST:</h4><p>Para cadastrar as informações da categoria, iremos utilizar a anotação <strong>@PostMapping</strong> para criar uma nova categoria.</p><p>A anotação <strong>@RequestBody </strong>indica que teremos um corpo no request da requisção. Nesse caso será um JSON com a categoria que iremos inserir.</p><p>A anotação <strong>@Valid </strong>indica que iremos fazer uso da validação via Bean Validation.</p><p>Em nossa reposta da requisição iremos seguir os padrões REST, retornando um código <a href="https://httpstatuses.com/">HTTP Status Code</a> correto para criação de recursos. O código será <strong>201 Created</strong>.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/bed3a71f1a6f4bdb56b9d9fd1e6a6d47/href">https://medium.com/media/bed3a71f1a6f4bdb56b9d9fd1e6a6d47/href</a></iframe><p>Também definiremos a lógica em nossa camada de serviço:</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/12ca24234f59260a331fc716cf8ca8fa/href">https://medium.com/media/12ca24234f59260a331fc716cf8ca8fa/href</a></iframe><p>Para testarmos, vamos realizar uma requisição POST para o endpoint: <a href="http://localhost:8080/categories">http://localhost:8080/categories</a> com o corpo da requisição JSON:</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*549fR2MgW5aYGy2Z9DMrdQ.png" /><figcaption>POST — Postman</figcaption></figure><h4>Consulta de dados com GET: Filtro, Paginação e ordenação</h4><p>Para consultar nossas categorias, podemos fazer uso da anotação <strong>@GetMapping</strong>, que indicará que queremos consultar recursos.</p><p>A anotação <strong>@RequestParam </strong>indica que um parâmetro de método deve ser vinculado a um parâmetro da requisição. Para manter esse parâmetro opcional, devemos adicionar o atributo “required = false”.</p><p><strong>@PageableDefault </strong>indica padrões nas informações da paginação em nosso RestController, como por exemplo, tamanho, número da página e ordenação</p><p><strong>@PathVariable </strong>indica que um parâmetro de método deve ser vinculado a um parâmetro indicado no endpoint.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/530fee144b6b5b81219d3849f142d8b7/href">https://medium.com/media/530fee144b6b5b81219d3849f142d8b7/href</a></iframe><p>Para suporte a paginação, precisamos também adicionar a anotação <strong>@EnableSpringDataWebSupport</strong> na nossa classe de inicialização <strong>BootstrapApiApplication</strong>.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/650b767534619fce418785a373676552/href">https://medium.com/media/650b767534619fce418785a373676552/href</a></iframe><p>Em nossa camada de serviço, adicionaremos:</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/64616a5cf6de0346bfde60ceacfefe6b/href">https://medium.com/media/64616a5cf6de0346bfde60ceacfefe6b/href</a></iframe><p>Para testarmos, pode realizar uma requisição GET para o endpoint: http://localhost:8080/categories?name=Transporte&amp;page=0&amp;size=2&amp;sort=createdAt,asc</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*MsC1naXRT3CV0yNslqTt3A.png" /><figcaption>GET — Postman — Consulta com filtro, paginação e ordenação</figcaption></figure><h4><strong>Atualizando dados com PUT:</strong></h4><p>Na atualização de recursos, temos disponível a anotação <strong>@PutMapping(“/{id}”)</strong>, que irá fornecer também o identificador que iremos manipular.</p><p>A anotação <strong>@Transactional</strong> fornece recursos de controle de transação.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/1aef19bc22dd51b118cf0dda9e26953b/href">https://medium.com/media/1aef19bc22dd51b118cf0dda9e26953b/href</a></iframe><p>E na camada de serviço:</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/dfc54407810cb05a76c24ca95504e54e/href">https://medium.com/media/dfc54407810cb05a76c24ca95504e54e/href</a></iframe><p>Para realizarmos uma atualização de uma categoria, poderemos realizar uma requisição PUT no endpoint: http://localhost:8080/categories/{id}</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*87zW_j7VPsuXXcktnhXfuw.png" /><figcaption>PUT — Postman</figcaption></figure><h4><strong>Deletando dados com DELETE:</strong></h4><p>Para removermos alguma categoria, podemos utilizar a anotação <strong>@DeleteMapping(“/{id}”).</strong></p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/e68bc3499242fae8ee791a26fffb44b3/href">https://medium.com/media/e68bc3499242fae8ee791a26fffb44b3/href</a></iframe><p>Na nossa camada de serviço:</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/d22d8dea869d0cafe1459e230a13798d/href">https://medium.com/media/d22d8dea869d0cafe1459e230a13798d/href</a></iframe><p>O teste pode ser feito com uma requisição DELETE no endpoint: <a href="http://localhost:8080/categories/%7Bid%7D">http://localhost:8080/categories/{id}</a></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*mUyS9SfXCG0cyVrzBzOExw.png" /><figcaption>DELETE — Postman</figcaption></figure><h4>Tratamento de erros com Exception Handler:</h4><p>Qualquer tipo de controller irá ser afetado por essa implementação. É uma espécie de interceptador. Muito útil para deixar nosso tratamento de erro genérico.</p><p>A anotação <strong>@RestControllerAdvice</strong> irá incluir as anotações <strong>@ControllerAdvice</strong> e <strong>@ResponseBody</strong> e poderemos tratar erros de forma genérica mas também específica com essa nova classe.</p><p>Podemos também implementar métodos da interface <strong>ResponseEntityExceptionHandler</strong> e manipular exceções respondendo de forma mais descritiva a requisição.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/d9383893be71d92f65b8a15357a02ff6/href">https://medium.com/media/d9383893be71d92f65b8a15357a02ff6/href</a></iframe><p>Também é possível adicionar um arquivo chamado <strong>messages.properties</strong> no path <strong>resources </strong>que irá conter as mensagens de validação recuperadas através do MessageSource definido acima.</p><iframe src="" width="0" height="0" frameborder="0" scrolling="no"><a href="https://medium.com/media/1c7edf07fffb4415f01cea5623456f7a/href">https://medium.com/media/1c7edf07fffb4415f01cea5623456f7a/href</a></iframe><h4>Conclusão</h4><p>Spring Boot é sem dúvidas um dos frameworks mais produtivos e utilizados para criação de microservices de alta performance. Com ele você terá suporte a diversos módulo que otimizarão o desenvolvimento e tem uma curva de aprendizado relativamente baixa.</p><h4><strong>Código completo disponível no Github:</strong></h4><p><a href="https://github.com/jorgesouza/bootstrap-api">https://github.com/jorgesouza/spring-boot-rest-kotlin</a></p><h4>Referências:</h4><ul><li>Algaworks. Curso Fullstack Angular e Spring. Disponível em: <a href="https://www.algaworks.com/curso/fullstack-angular-e-spring/">https://www.algaworks.com/curso/fullstack-angular-e-spring/</a> Acesso em: 12 de abril de 2020</li><li>Alura. Spring Boot Api Rest. Disponível em: <a href="https://cursos.alura.com.br/course/spring-boot-api-rest">https://cursos.alura.com.br/course/spring-boot-api-rest</a> Acesso em: 12 de abril de 2020</li><li>Fowler, Martin. Richardson Maturity Model. Disponível em: <a href="https://martinfowler.com/articles/richardsonMaturityModel.html">https://martinfowler.com/articles/richardsonMaturityModel.html</a> Acesso em: 12 de abril de 2020</li><li>HTTP Status Codes. Disponível em: <a href="https://httpstatuses.com/">https://httpstatuses.com/</a> Acesso em: 12 de abril de 2020</li><li>Spring.io. Query Creation. Disponível em: <a href="https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation">https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation</a> Acesso em: 12 de abril de 2020</li></ul><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=e13890bcb1e7" width="1" height="1" alt="">]]></content:encoded>
        </item>
    </channel>
</rss>