0

Carreira – Resumo Swagger

#Java #Boas práticas
Rosemeire Deconti
Rosemeire Deconti

Carreira – Resumo Swagger

Estou conhecendo várias ferramentas nos Bootcamps da DIO e tem muito conteúdo. Este texto é um resumo básico sobre Swagger.


Como de costume ao final deste artigo estão as referências que utilizei para criar este texto.


Bons estudos e persistência para que o sucesso ser alcançado!


Neste link vocês encontram todos os artigos que publiquei na Digital Innovation One

Digital Innovation One - Lista de artigos publicados na DIO


O que é Swagger ?

Swagger é um framework para descrição, consumo e visualização de serviços RESTful.


As vantagens de utilizar o Swagger são basicamente: Modelar e documentar APIs REST.


O objetivo é permitir que a documentação possa evoluir no mesmo ritmo da implementação, já que pode ser gerada automaticamente com base em anotações do código.


O Swagger tem um módulo de user interface que permite aos desenvolvedores interagirem com as APIs em sandbox de forma muito intuitiva como podemos ver na imagem abaixo, sem exigir conhecimento da implementação ou mesmo dos parâmetros e opções (que são explícitas na documentação).



O Swagger é composto por diferentes ferramentas, que ajudam no desenvolvimento de APIs:


1) Swagger Editor: Um editor poderosíssimo que pode ser usado online, e que facilita (e muito) na escrita de arquivos Swagger.


2) Swagger UI: Uma plataforma para a geração e publicação da documentação de APIs.


3) Swagger Codegen: Através da especificação da sua API, cria SDKs para diferentes linguagens.


4) Swagger Inspector: é um serviço que testa APIs com base em um contrato Swagger.


O que é REST / RESTful?

REST significa Representational State Transfer. Em português, Transferência de Estado Representacional. Trata-se de uma abstração da arquitetura da Web.


Resumidamente, o REST consiste em princípios/regras/constraints que, quando seguidas, permitem a criação de um projeto com interfaces bem definidas. Desta forma, permitindo, por exemplo, que aplicações se comuniquem. Interessante saber que:


REST = conjunto de princípios de arquitetura

RESTful = capacidade de determinado sistema aplicar os princípios de REST.


O que é API ?

API é o acrônimo de Application Programming Interface ou, em português, Interface de Programação de Aplicativos.

Esta interface é o conjunto de padrões de programação que permite a construção de aplicativos e a sua utilização de maneira não tão evidente para os usuários.


API é a “matrix” dos aplicativos, ou seja, uma interface que roda por trás de tudo: enquanto você usufrui de um aplicativo ou site, a sua API pode estar conectada a diversos outros sistemas e aplicativos. E tudo isso acontece sem que você perceba.


As APIs proporcionam a integração entre sistemas que possuem linguagem totalmente distintas de maneira ágil e segura.


Ferramentas Swagger

No framework Swagger, existem ferramentas para os seguintes tipos de tarefas a serem realizadas para o completo desenvolvimento da API de um serviço WEB:


1) A especificação da API consiste em determinar os modelos de dados que serão entendidos pela API e as funcionalidades presentes na mesma. Para cada funcionalidade, é preciso especificar o seu nome, os parâmetros que devem ser passados no momento de sua invocação e os valores que irão ser retornados aos usuários da API. Entre esta ferramentas, podemos citar o OpenAPI Specification.


2) Após especificar a API, o framework facilita sua implementação, com a ferramenta Swagger Codegen é possível montar o código inicial automaticamente nas principais linguagem de programação.


3) Os testes de API são extremamente importantes, pois ajudam a garantir o funcionamento, o desempenho e a confiabilidade da sua aplicação. O Swagger oferece ferramentas para teste manuais, automatizados e de desempenho.


4) Para auxiliar na utilização da API, o Swagger dispõe de ferramenta para deixar a visualização mais intuitiva, permitindo também que interajam com a API.


Formas de criar documentação da API

1- Automaticamente: Simultaneamente ao desenvolvimento da API é gerada a documentação.


2- Manualmente: Permite ao desenvolvedor escrever livremente as especificações da API e as publicar posteriormente em seu próprio servidor.


3- Codegen: Converte todas as anotações contidas no código fonte das APIs REST em documentação.


Referências

Porque usar Swagger na sua API?. API é o acrônimo de Application… | by Aristoteles Lopes | Medium

Documentando sua API Rest com Swagger - TerraLAB (ufop.br)

Swagger e o Open API Initiative | Klaus Laube

0
2

Comentários (4)

0
Rosemeire Deconti

Rosemeire Deconti

08/06/2021 13:53

Eduardo! Grata pelo comentário! Vou também fazer um artigo sobre Postman .... kkkkkkk ... também é uma novidade para mim ... pelo que eu saiba as duas ferramentas auxiliam no desenvolvimento de APIs e o Swagger tem funcionalidades auxiliares sendo uma delas auxiliar na documentação da API .... meu foco agora para o bootcamp CodeAnywhere. Bons estudos e sucesso!

0
EDUARDO CUPERTINO

EDUARDO CUPERTINO

08/06/2021 13:11

Muito bom! Chego a pensar que o postman não é mais necessário. Será?

0
Rosemeire Deconti

Rosemeire Deconti

08/06/2021 10:39

Rogério Santos! Que bom que foi útil para você! Conceitos são importantes e era isso que eu procurava quando escrevi o artigo. Bons estudos e sucesso!

1
Rogério Santos

Rogério Santos

08/06/2021 09:32

Muito bom Rosemeire!!! Era o que eu estava procurando.

Apaixonada por tecnologia e informação. Na área desde 1.984 e sem previsão de parada.

Brasil