Swagger (suas APIs documentadas sem esforço) // Dicionário do Programador

e contextualizando Suada é uma ferramenta open source para visualização dinâmica do funcionamento de hippies veste está presente no desenvolvimento back-end e ajuda os desenvolvedores front-end a consumir as reais podemos dizer então que o swag é um Framework que cria automaticamente documentação para auxiliar o uso de uma equipe ai mas ele é mais do que isso é verdade viu uma boa documentação ajuda Deveras Ainda mais se estiver tratando do consumo de código alheio Então vem com a gente nesse vídeo descobrir como suave ele funciona e como já sair daqui criando uma documentação para o seu código

PIN [Música] Olá seja muito bem-vindo ao dicionário do programador nesse vídeo vamos desvendar essa ferramenta maravilhosa que deixa os desenvolvedores jeito e as mais felizes que você já é consumidor de e paz com certeza deve ter visto alguma documentação gerada pelo Swag aí não conhece não tem problema viu esse vídeo vai te mostrar como começar nessa ferramenta Aliás se você gosta desse tipo de conteúdo não deixa de se inscrever aqui no canal para acompanhar semanalmente nossos vídeos sobre essa Incrível Mundo da programação pronto sempre já esse vídeo nossa parceira a loira se você nos acompanhe

a gente tá ligado no mundo do desenvolvimento é simplesmente impossível não conhecer esse nome é o maior plataforma de ensino de Tecnologia do Brasil tem imagine 300 cursos com dezenas de instrutores está sem o que está colhendo a comunidade deve com as suas emissões uma plataforma incrível para quem quer se manter atualizado em está por dentro de várias áreas da tecnologia se você ainda não é um dos alunos e estava só esperando um desconto para sempre a circular a sua hora chegou Como acessar o link que está aqui na descrição e aproveitar foi criado lá

atrás em 2010 por Tony Ramos um desenvolvedor do software bem conhecido na comunidade na padronização de gpias ele já trabalhou na Linux foundation e foi o criador da especificação Open up a atualmente faz parte do time do iCloud da Apple suéter foi criado pensando justamente no design construção descrição produção consumo e visualização dos endpoints de uma hippie vest se você ainda não sabe o que é uma equipe e eu ainda o que é o resto aconselhamos fortemente que você siga nesse vídeo aqui que está no card Tony criou Swag justamente baseado na especificação da Open

ipe ai se eu não formato descritivo que aceita os formatos Jason e olha um homem aí piá é de grande importância para nós desenvolvedores pois como uma especificação de aberta ele permite ter projetos bem mais enxutos e certamente bem documentado feito essa introdução e antes da gente mostraram sua é uma pergunta eventualmente SUS porque não ter uma ideia e documentada em importantes aqui para responder essa pergunta a gente apresentam a carinha de um projeto criado pelos wegher Olha que lindo basicamente o ovo e aí piá veio para padronizar a forma como arrepiar e são documentados

especificamente a CPI rest para isso o padrão pouco Ibiá é agnóstico de linguagem podemos ser usado de forma simplificada em sua linguagem favorita a documentação que o swag cria é simplesmente incrível Olha só isso pesquisei no Swag champ uma e piadas sobre Pokémon escolhi uma da lista e aqui a gente já consegue ver que a documentação é baseado no exemplo pões O legal é que é possível identificar rapidamente através dos métodos o que o end Point faz sobre o lume entrypoint podemos ver como fazer para utilizar ele em nosso código é possível também realizar chamadas

de teste e ver o retorno Daí piá em Ação assim antes de ficou dar já sabemos o que es Oi Bi prático no mesmo então não resta dúvida que o projeto de equipe Afonso Aguiar agiliza bastante o design desenvolvimento testes e também a sua documentação e para fazer isso e ainda mais prático Pois é possível experimentar aí piá usam do SWAG em ambientes de desenvolvimento development ou homologação utilizando os dados mokados ou reais onde podemos utilizar os flagras recordo mas também através do endereço Swag. Aí ou lá é impossível ver que em ferramentas open-source temos

o SWAG SWAG Uai News weather Cold Jam um editor fica muito mais fácil criar o design e estrutura de uma ipiae como os endpoints parâmetros metros etc uma vez criado já é possível compartilhar a documentação e testar o uso simulando chamadas através do sueder e o Lembrando que não é obrigatório essas ferramentas se você já tiver uma ipiaê criada é possível conectar ela ou Swag é tão bem virar código quer ver como é que faz a implementação do sueder na sua aí é bem molezinha você pode configurar um pouco espaço citam como exemplo nós utilizaremos

honesto GPS para demonstrar a usabilidade é preciso nesse caso ter um node DS e o npm instalado para isso podemos começar criando um projeto com né se GS agora entre na parte do projeto instale os pacotes wegher e Suede New Express como você tá vendo com os pacotes devidamente instalados vamos configurar o projeto para usar a rota Docs para servir a documentação Swag Abra seu arquivo meio. TS e adicione-os wedding mode on e o documento builder com as informações de sua equipe agora basta configurar com os seus de teológico e Piauí property para poder visualizar

a documentação básica gerada pela ferramenta O resultado é uma documentação com exemplos de corpo de requisição com esquema da tipagem dos dados um esquema de dados além de indicar a tipagem indicam os campos que são requeridos ou não e também mostram os exemplos de funk citamos anteriormente agora que você aprendeu virar código que tá o vemos como utilizar também o crédito Para darmos início a uma documentação no cada usaremos Jackson Mas como já falamos antes pode ser utilizado o iene Eu também usando Jason especificamos como nossa equipe as sei lá escrevendo cada parte seguindo a

especificação Ops citada anteriormente dessa forma Já podemos ter algo para mostrar antes mesmo do projeto será finalizado isso é muito muito em qualquer projeto que tem sede de uma demonstração onde agilidade no processo tanto para o time front-end quanto provar 500 recebendo Cicinho com Swag desenhado antes da cor de ficar são só como curiosidade a Smart BR empresa que mantém atualmente o seu desenvolveu o swag Everton e o Suelen Uruguai inteiramente usando ricms-df dá o seu Record News weather Cold gen foram criados com Java e mustache podemos deixar esse vídeo sem citar alguns dos concorrentes

no Swag aqui não tá sozinho nesse mundão das leis O que você já deve conhecer é o bolso mesmo que também suporta a especificação do outro e enviai e isso importa usar e pensam do SWAG podemos citar ainda o Up here with me you Stop Light e oxigênio Aliás se você conhece alguma outra aí deixa aqui nos comentários para gente saber para finalizar não custa reforçar que não é necessário ter uma equipe pronta para começar a documentar com Swag você pode descrever como será e piai E com isso definir os detalhes e inclusive definir como

será a autenticação por jwt por exemplo você aprendeu algo que ainda não sabia nesse vídeo Essa é a sua hora de contar para a gente aqui nos comentários e também deixar aquele joinha ficar sabendo que esse vídeo te ajudou se você quiser continuar com a gente eu sugiro que você fique para nossa próxima indicação que vem logo depois da vinheta então grande beijo para vocês um abraço e até mais é sempre muito bom dia que você chega até o fim do vídeo esperando a nossa próxima recomendação Que tal você então se deleitar com um dos

primeiros dicionários do programador lá de tubo de 2 e é esse mesmo viu que tá aqui do lado onde nós destruir estamos O que é uma equipe e no contexto geral não só para web vale a pena ver nem que seja para ver a gente um pouquinho mais novinho né Gabriel estamos lindos