O que é SWAGGER: A Documentação da API Rest

eu uso já fez has tem crescido cada vez mais e para que você consiga entender como manipular o matei o resto é muito necessário que você sai balera documentação dela hoje em dia a ferramenta principal quando nós falamos de documentação de uma pelo resto é o sueder que basicamente é uma descrição de quais são todos os recursos que você pode utilizar dentro daquela determinada apehist Quais são as operações que você pode usar e também quais são os parâmetros a serem enviados para ela é e como é um assunto que para quem já conhece sobre apenas resta soa como trivial muitas vezes a gente não encontra documentação sobre isso ou algum tutorial por isso que eu gravei nessa aula aqui para você para que você consiga entender uns wegher e então poder fazer a leitura da documentação da sua a perversa e E aí a hora que você conseguir entender com clareza a documentação dos wegher é necessário que você entenda bem o que é uma requisição pelo menos E para isso eu trouxe aqui para você hoje um dos slides que eu uso dentro do meu treinamento programa de testes e qualidade de software onde eu ensino os meus alunos sobre como transformar como alavancar sua carreira em testes e qualidade de software ser mais valorizado beleza eu quero explicar isso para você na seguinte fala imagina que antigamente na arquitetura comum do passado era você ter um software que dentro dele existia todas as regras de negócio então tudo ficava armazenado dentro de uma única uma única aplicação então se você tinha uma aplicação desktop as regras Estavam todos lá dentro se você tinha uma aplicação web as regras estavam todas lá dentro o que foi acontecendo com o decorrer do tempo é que a gente começou a é isso não era um modelo sustentável visto que se você tivesse duas aplicações você teria aqui da manutenção nas duas caso você tivesse uma mudança na regra de negócio então o que aconteceu aquela regra de negócio foi extraída dessas aplicações e colocada em uma outra que aqui eu tô representando como sendo um up é Então essas aplicações aqui desktop e webb passaram então a consumir é essa aí beleza só cabei não tem o rosto não é um software que está aqui que você que é na verdade o rosto da do seu do seu sistema está na verdade aqui na frente nas aplicações desktop ou mobile web por exemplo certo e aí ficou aqui atrás sem rosto essa questão dos sem-rosto quer dizer que você não tem uma interface gráfica para que você vai lá e clique digite navegue na isso acontece todo na aplicação front-end então né sábado aí a extração aqui diz que eu tô falando você vê o José sendo o usuário que usa um aplicação 1 ep 1 ep Mobile Apps desktop web web na usa essa essa aplicação e essa aplicação conversa com o Up Mas conversa com a p i como enviando uma requisição essa requisição como se fosse a caixinha que você tá vendo aqui ela tem um espaço para que você aponte Qual é o método um espaço para onde você aponte Qual é a u r o espaço para onde você aponte Qual é o cabeçalho e um espaço onde você aponte Qual é o corpo Ok E aí talvez você diga mais julho o que é Método que é o r o que é cabeçalho O que é corpo essas informações todas são informações similares essa daqui então no método você tem lá um a uma intenção de o que você deseja fazer então aqui eu tô falando quero fazer um post geralmente quando a gente fala post em Atenas Grécia a gente já pensa imediatamente em a inserção de um recurso ou em alguns casos muito específicos a pesquisa ou busca de alguma informação ok e ao R que quando nós temos então uma o caminho de qual é o recurso que nós queremos é acessar aqui nesse caso a recurso produtos que está dentro dando as ati da lojinha Ok E aí nós temos ali no cabeçalho algumas informações técnicas como por exemplo o token botou quem é o que representa a autenticação do de um determinado usuário e por fim nós temos o corpo que é geralmente utilizado quando nós temos alguns métodos por exemplo métodos de que você tem intenção de inserir ou de alterar ou também como eu já tinha dito antes em casos remotos de buscar algum tipo de informação e aí nesse caso nós temos ali embaixo e se esse corpo que a basicamente Qual é o objeto que você quer adicionar dentro daquele determinado recurso Ok então toda a requisição tem esse grupinho de desculpa não todo a maioria das requisições tem esse grupinho aqui desses quatro elementos Ok algumas aquisições não precisam ter aquele quarto elemento que é o corpo como eu disse precisamos eu vou se eu vou buscar algum tipo de informação ou se eu vou deletar algum tipo de informação quando a gente fala em apenas resto Geralmente eu não preciso do corpo entendeu cabeçalho às vezes eu preciso me autenticar para conseguir ter acesso a algum tipo de recurso específico mas tem alguns momentos que eu não preciso então tem horas que eu não preciso do toque por exemplo quando eu vou fazer login na aplicação eu não preciso do toque porque porque eu nem tenho toc ainda quero ir na lugar eu quero a minha autenticar naquela determinada aplicação Ok então perceba que a gente tem essa estrutura e essa estrutura ela é composta por dois itens que sempre vão ter que aqui qual é o método que você vai utilizar que aquela primeira caixinha E qual é rir para vou mandar aquilo e depois você tem o cabeçalho que você pode ter ou ter que informar ou não e você tem o corpo que novamente você pode ter que informar ou não Dependendo de qual é o tipo de operação que você tá fazendo eu chamo de operação aqui a mistura do que é o método junto com o recurso Ok junto com o Henrique você tá vendo ali é porque isso porque essa junção dos dois definir o que é que você tá querendo fazer na sua perversa bacana na uma vez que a lojinha é Envia essa requisição para abrir app e processos a informação e devolve uma resposta E na resposta a gente tem algo similar a requisição a resposta ela não tem um método porque ela é simplesmente uma resposta do Servidor para você então não é como você tinha uma intenção de fazer algo Então ela tem essa resposta ela também não vai ter ao R porque ela simplesmente retorna a quem a chamou ok é só tem cabeçalho e ela também tem corpo porque porque no cabeçalho vem algumas informações importantes do Servidor e dentro do corpo vem para você as informações que você requereu do Servidor então se eu por exemplo é disse ao servidor que eu quero fazer um jet que é buscar de produtos que que ele vai trazer ele vai trazer para mim todos os produtos que pertencem a mim que tem algum ela o relacionado à ao usuário que eu sou como que eu demonstrei Qual é o usuário através do Token Ok bom isso tudo aqui que eu tô falando para você tem a ver com o resto e com arquitetura de uso de apê isso ok a gente ainda não tá entrando no assunto suagher por quê Porque você é primeiro precisava entender como é que funciona uma requisição pelo menos para que você possa entender como é costurar de Assunção e também que existe uma resposta Ou seja eu envio essa requisição e obtém uma resposta beleza show Agora sim a gente pode ir Oi nega é bem os wegher ele é uma aplicação que permite a você fazer diversas coisas relacionadas Apiaí Santo de documentação quantos também de desenho já fez ok ele tem várias ferramentas voltadas à isso um Swag que essa documentação da api rest ele é escrito através de um arquivo com a extensão yml ou painel aqui do lado esquerdo você vê um for um conteúdo de um arquivo WMA que é um conteúdo que já está aqui dentro do site do Sul é Benedita como sendo um exemplo de O que é uma definição de um app iOS você acessa esse site aqui com o endereço Editora. Swag apontaram ok e do lado esquerdo então o conteúdo do arquivo é meu do lado direito o que é a mágica do SWAG daquele Ele demonstra para você o conteúdo a proposto pelo próprio Swag em o Ariel do lado direito aqui de uma forma similar uma interface gráfica de um site qualquer só que aqui é uma documentação certo então você vê aqui o que eu disse para você de qual os quais são os métodos e as suas os seus recursos Ok E aí o que acontece se você consegue ver que aqui dentro dessa dessa api chamada Pet Store na versão 1. 0.

0 você consegue ver quais são todas as operações que ela tem e ainda não e aí vendo as operações Você sabe o que é que você pode fazer por exemplo é post/Pet que que esse post/PET faz ele adiciona um novo pet para loja parte Bacana Então quer dizer que se eu fizer uma requisição para uma Wesley dessa dessa loja apontando aqui um recurso então ficaria por exemplo Pet Store pontos Where. Aí o barra de 2/pé então um post para Pet Store. Sobre.

Aí o Barra V2/Pet vai se eu passar todas as informações necessárias necessários vai adicionar um novo pet para loja bacana né então é dessa forma aqui que você faz a leitura do sangue mas veja agora tá mais fácil para você porque você já sabe o que é uma requisição Então você sabe que para que você possa interagir com ati é necessário que você saiba Quais são as operações permitidas O que é uma operação edineu Adicionar novo Pet essa é outra operação Olha só atualizar um pet que já está dentro da loja Ok Jet/Pet/painters encontrar um pet através do seu estado o Jack Pet/petside encontrar um pet através do seu Wide então o que você faz desse por exemplo nesse barra Pet barragem de você envia uma requisição via Jet para o https://Pet Store. Swagger. io/V2/Pet/77 por exemplo Vamos ver que essa Wide do seu Pet 77 e ele vai lá então e buscar as informações do Pet através do seu agir entendeu então aqui você tá vendo pela primeira vez o uso de um parâmetro que parâmetro que esse é um parâmetro que a pênis vai nós chamamos de parâmetro peço peço de caminho por quê Porque você tá informando o número 77 no mesmo lugar onde você informa qual é o endereço a URL para onde você quer enviar aquela determinada requisição bacana né o parâmetro pef onde mais nós temos parâmetros peça aqui olha só no post Pet/aí no no de Elite de Elite Pet/petside no post post Pet/Pet Eyed/upload image Olha só no Swag tem esse tipo de informação aqui também que é bem relacionado ao a forma com que a pele foi desenvolvido veja eu quero fazer o upload de uma imagem Mas é uma pelo de uma imagem de quem do Pet número e aí você vai ter um número qualquer aqui 77 daqui a outra coisa interessante não é porque tem essa chave aqui que você tem que colocar a chave 77 é só 77 Ok esse chave aqui representa que você vai substituir esse chave Pet aí de por um número qualquer aqui que é o número referente a um pé então voltando aqui eu quero fazer o upload de uma imagem do Pet 77 do do do AIDS 77 dos nossos pés bom então isso aqui é um defe para mim ir ou um parâmetro F dentro do SWAG e você vai ver aqui isso e geralmente acontece em alguns em algumas alterações aqui que a gente vai fazer ela aqui novamente tem e aqui também tem tá vendo Então é muito comum e olha só que da hora porque o o parâmetro pé não é só inteiro como você tava vendo aqui as vezes pode ser texto Julho quem define essa Quais são as operações disponíveis e se tem ou não um pé aí de ou um parâmetro peça quem decide isso é o engenheiro de software que tá pensando aqui nessa ap Então essa pessoa ela foi lá e falou a vai ser dessa forma aqui que a gente vai ter isso não o engenheiro arquiteto de software dependendo a gente Quais são os papéis que você tem dentro do seu TIM é que definir em qual vai ser as operações permitidas E qual vai ser os parâmetros efe que vão existir ele só que nós não temos apenas o parâmetro pé a gente também tem um parâmetro chamado Harry se esse parâmetro com ele funciona é um esquema que você já deve ter visto nas aplicações que você nos sites que você utiliza é o seguinte eu vou digitar lá né http essa daqui vai ser o endereço ao RN para onde eu vou mandar o meu a minha requisição https://Pet Store pontos Weber.