COMO GERAR API REST COM editor.swagger.io À PARTIR DO ARQUIVO .yaml

Neste post irei mostrar como gerar uma API REST com Spring Boot à partir do arquivo.yaml utilizando o editor.swagger.io veremos que isto é bem simples.

Inicialmente irei colocar o swagger.yaml no editor.

swagger5

No menu Generate Server irei selecionar a opção spring e salvar como clienteAPI.zip.

clienteapi1

Irei ao diretório onde salvei o arquivo clienteAPI.zip e o descompactarei.

clienteapi3

Abrirei a pasta clienteAPI para acessar a pasta spring-server.

clienteapi4

Já na pasta spring-server podem ser observados os arquivos pom.xml,readme.md e a pasta src.

cliente5

Pronto, agora basta importar este projeto para a IDE de desenvolvimento(eclipse, IntelliJ, …) e finalizar o desenvolvimento de conteúdo de retorno do controller. É importante ressaltar que a parte mais pesada, no caso o desenvolvimento do projeto foi realizada pelo editor. Este projeto roda normalmente no servidor de aplicação(Tomcat,…).

Para baixar o projeto completo click aqui.

Até a próxima.

Anúncios

Como criar API Rest com Swagger – CRUD completo

Hoje irei falar sobre Swagger, um projeto que possui algumas ferramentas para auxiliar o desenvolvedor na criação de APIs Rest e sua documentação de maneira rápida e portável. Irei criar um arquivo .yaml que possui uma aparência semelhante a um arquivo de texto. É muito importante entender que toda a parte burocrática de mapeamento de URIs será declarada de forma simples neste arquivo, bem como a declaração de MODELs. Após a criação do arquivo será possível criar um projeto em diversas linguagens de programação tanto o Server quando o Client através do editor.swagger.io. No editor do swagger é possível criar o arquivo .yaml e um client da aplicação é carregado live load.

swagger-7

Caso exista algum erro de sintaxe ou identação a linha com erro fica marcada e uma breve explicação é exibida. Após desenvolver o arquivo .yaml basta gerar o projeto Maven através dos menus Genarate Server ou Generate Client ou para quem desejar gerar a partir do .pom do projeto maven também será possível, mas isto é assunto para um próximo post quem sabe.

swagger-11

swagger-12

Irei mostrar a criação de um arquivo swagger.yaml bem simples para uma API REST com um CRUD de Cliente.

  1. Definições básicas da aplicação

Nome da API, titulo, contato, licença, host, basePath da aplicação, schemes e tags.

swagger-1

swagger-8

Declaração da seção paths onde  de finimos as URIs da aplicação.

  1. Declaração da URI de CRIAÇÃO

Declaração da URI de criação do cliente, tag associada, tipo de consumo (neste caso json), tipo de produção/retorno(neste caso json), parâmetros da URI, schema (corpo da requisição) e tipos de respostas para esta requisição.

swagger-2

  1. Declaração da URI de CONSULTA

Declaração da URI de consulta do cliente, tag associada, tipo de produção/retorno(neste caso json), parâmetros da URI e tipos de respostas para esta requisição.

swagger-14

  1. Declaração da URI de ALTERAÇÃO

Declaração da URI de alteração do cliente, tag associada, tipo de consumo (neste caso json), tipo de produção/retorno(neste caso json), parâmetros da URI, schema (corpo da requisição) e tipos de respostas para esta requisição.

swagger-13

  1. Declaração da URI de REMOÇÃO

Declaração da URI de remoção do cliente, tag associada e tipos de respostas para esta requisição.

swagger-15

Abaixo pode ser observado o resultado da declaração de todas as operações desta API.

swagger-9

  1. Criação do Model CLIENTE

Declaração dos dados do cliente tipando cada dados de acordo com o seu tipo.

swagger-6

swagger-10

Conclusão

O Swagger permite documentar a API e testar a mesma enquanto o desenvolvedor cria o arquivo.  Espero que tenham gostado.

Este arquivo pode ser baixado em cliente.yaml.

Um grande abraço.

Configuração de ambiente para Angular 4 no Ubuntu 17.10

No post de hoje irei apresentar uma das formas de configurar o ambiente Ubuntu 17.10 para desenvolver em Angular 4. 

 

Primeiramente iremos instalar o NodeJS.

instalarNodejs

Vamos verifacar a versão do Nodejs.

verificarVersaoNode

Iremos instalar agora o NPM.

instalarNPM

Verificando agora a versão do NPM.

verificarVersaoNPM

Por fim vamos instalar e verificar a versão do Angular.

instalarAngularCLIverificarVersaoAngularCLI

Como podemos observar a instalação do Angular 4 no Ubuntu depende da instalação do NodeJS e do NPM, mas é uma instalação bem simples.

Espero que este post ajude aqueles que tem interesse em instalar o Angular 4 no Ubunto.

Um abraço!

Exemplo de Documentação para Gestão de Projetos

Olá, pessoal!

No post de hoje irei compartilhar um trabalho desenvolvido pelo meu grupo na pós, este é um exemplo de documentação para gestão de um projeto de desenvolvimento de sistemas.

Caso tenham duvidas ou sugestões por favor comentem.

Obrigado, um grande abraço!

 

 

Conhecendo HSQLDB banco de dados em memória

Olá, no dia de hoje irei mostrar a simplicidade da instalação do HSQLDL. Antes disto irei falar um pouco sobre ele. HSQLDB ou Hyper Structured Query Language DataBase é um SGBD de código aberto escrito em Java. É uma solução simples comparado ao Oracle e SQL Server, possui poucos recursos, porém um bom desempenho. É mais indicado para aplicações desktops. Dá suporte a schemas, seleções, joins, functions, sequences,  triggers e views. Pode ser classificado também como banco de dados em arquivo texto e em memória. Pode ser utilizado em projetos embarcados pois salva as informações dentro do .jar do projeto, em memória ou no servidor. As informações Uma das vantagens é o pouco espaço de disco necessário. Possui um client SQL simples para acessar o banco. Link de acesso para download do HSQLDB.a1

Acessando o Client e Server do HSQLDB com o hsqldb.jar com dublo click.01

a2

 

Siga as configurações abaixo para configurar o banco de dados:

Criando base de dados:

Crie uma basta chamada db no diretório de sua preferência. Ex: C:\Users\fulano\db.c2

Configure a conexao:

Setting Name: MyServerDB, Type: HSQL Database Engine Server, Driver: org.hsqldb.jdbcDriver, URL: jdbc:hsqldb:hsql:file:C:\Users\fulano\db\restaurantes, User:sa, Password: sa .

c3

Clique em OK.c4

c5

Base de dados criada com sucesso.

Teste a base de dados com os comandos abaixo:c6 c8

c9

 

Está é uma configuração básica para utilizar o HSQLDB, espero que tenham gostado. Deixem um comentário com dúvidas ou sugestões.

Um grande abraço!