‫Narrador: Então, nossa API está basicamente concluída.
‫E então, neste vídeo
‫final da seção, vamos criar rapidamente
‫a documentação da API diretamente no Postman.
‫E isso mesmo, podemos
‫criar facilmente alguma documentação rápida direto no Postman.
‫E é muito importante ter a documentação da
‫API em vigor porque é assim que nos comunicamos com os membros da
‫equipe, ou mesmo com os usuários finais da API, como
‫eles podem realmente usá-la na prática.
‫Deixe-me mostrar como funciona.
‫Agora, antes que possamos realmente criar a documentação,
‫vamos apenas fazer uma limpeza aqui.
‫Por exemplo, livre-se deste pedido, certo?
‫Outra coisa que eu quero fazer é aqui no ponto
‫de login, nós realmente expomos nossa senha aqui.
‫E isso não é uma boa ideia, então o que
‫vou fazer é criar uma variável de
‫ambiente que vai manter essa senha.
‫Como é sempre igual, não deve haver problema.
‫Portanto, lembre-se de como fazemos isso.
‫Bem, viemos aqui para gerenciar o
‫meio ambiente e aqui simplesmente adicionamos outro.
‫Então, senha, test1234.
‫E aqui não está correto, então senha, atualizada, e agora vamos fazer
‫o mesmo aqui na
‫produção também.
‫Então, senha, test1234.
‫E então, não adicionar, mas vamos fechar isso e
‫aqui agora posso adicionar e usar isso,
‫não em uma string, mas assim.
‫Portanto, senha.
‫Então, vamos tentar isso.
‫E isso nos dá um erro estranho, mas
‫nossa senha está realmente aqui, então provavelmente
‫o que precisamos fazer é realmente colocar as aspas aqui.
‫Então, vamos tentar isso.
‫E agora, de fato, estamos logados com sucesso.
‫Então salve isso agora, ok?
‫E agora o que devemos fazer é realmente
‫criar uma descrição para cada pedido que
‫temos em nossa coleção.
‫Claro que não vou fazer
‫isso, vou apenas exemplificar aqui com o primeiro.
‫OK?
‫Então, vamos fechar esses
‫outros e agora podemos adicionar uma descrição.
‫E então vamos apenas dizer, use este ponto
‫de extremidade para criar um novo passeio.
‫Ok, e novamente, agora você deve fazer exatamente a mesma coisa
‫para todas as suas solicitações se seu objetivo for realmente
‫publicar e compartilhar sua API, certo?
‫Então a mesma coisa se aplica às pastas,
‫e não para renomear, mas para editar.
‫E assim, em cada
‫uma dessas pastas, também podemos adicionar uma descrição.
‫Então, digamos algo aleatório como, você pode
‫obter todos os passeios, criar
‫novos
‫e editar e excluir passeios.
‫Existem também terminais especiais para alguns
‫requisitos especiais.
‫Ok, isso é totalmente aleatório
‫e eu publicaria algo assim para minha própria API,
‫mas aqui realmente queremos apenas testar como funciona, ok?
‫Como você pode ver
‫aqui embaixo, você também pode usar o Mark aqui, ok?
‫Então, por exemplo, para deixar o texto
‫em negrito, você pode pensar que funciona assim, sim,
‫parece que sim, e então
‫sim, você pode fazer todos os tipos de coisas aqui, ok?
‫Provavelmente, você também
‫pode criar uma descrição
‫no próprio Natours, então digamos que a API
‫Natours contém endpoints para passeios, usuários e avaliações.
‫E, novamente, um monte
‫de coisas, como você poderia descrever seu processo
‫de autenticação, ou suas permissões e realmente tudo
‫que o usuário precisa saber para usar esta API, ok?
‫Portanto, você deve
‫sempre adicionar uma descrição a todas as solicitações, a todas
‫as pastas e também, é claro, à própria coleção.
‫Ah, e podemos realmente descrever os parâmetros de consulta em uma string
‫de consulta, então vamos fazer isso aqui.
‫E também podemos dizer que ele suporta
‫maior que, menor que igual, maior que e menor que operadores.
‫Então, novamente, apenas um exemplo
‫aqui e vamos salvá-lo agora na solicitação.
‫E com isso, acho que devemos
‫estar prontos para realmente publicar nossa documentação de API.
‫E então, para fazer isso, vamos apenas ir
‫aqui para a opção de coleções e, em
‫seguida, publicar aqui as documentações.
‫E então isso deve abrir uma janela do navegador, e
‫para mim isso aconteceu fora da
‫minha tela, então deixe-me pegar isso aqui.
‫E agora você pode escolher o ambiente.
‫Então aqui devemos ter uma lista de nossos ambientes, o
‫que por algum motivo não temos, isso é estranho, mas de qualquer
‫maneira, não queríamos usar nenhum ambiente de qualquer maneira, porque
‫isso substituiria nossas variáveis
‫de ambiente por seus valores reais, e não
‫queremos isso.
‫Por exemplo, usamos a variável de
‫ambiente na senha, para
‫que posteriormente na documentação não fique realmente visível, ok?
‫Portanto, realmente não queremos usar nenhum ambiente.
‫Agora também podemos usar
‫um domínio personalizado, mas isso é apenas para usuários pagos, certo?
‫Então, também poderíamos alterar todo o estilo da
‫API para combiná-lo com as cores da sua marca, mas,
‫novamente, isso não é necessário neste
‫caso e, portanto, vamos em frente e publicá-lo.
‫E agora, isso é realmente
‫público, para que todos possam ver sua documentação agora neste URL.
‫Agora, por algum motivo, ele realmente não atualizou todas as mudanças que
‫acabamos de fazer antes, o que é um pouco estranho.
‫Então, vamos voltar ao Postman e ver
‫o que está acontecendo.
‫Talvez tenha a ver com essa coisa rotativa aqui, então vou apenas
‫encerrar o Postman e abri-lo novamente.
‫E vamos esperar que isso corrija isso.
‫Então, se recarregarmos aqui,
‫ahh, teremos todas as nossas alterações aqui.
‫Veja, a descrição que
‫adicionamos para a coleção Natours, certo?
‫Em seguida, também a descrição para esta pasta
‫e a descrição para esta solicitação.
‫E por fim, como
‫primeira descrição, também para esse parâmetro, ok?
‫Aqui, obtemos a variável de ambiente do URL em
‫vez do URL real.
‫Agora, é claro, você pode querer realmente fornecer
‫a URL real aqui e,
‫para isso, pode simplesmente usar outro ambiente.
‫Então, aqui em cima você pode ver
‫todos os ambientes, mas eles são privados, então agora ninguém
‫pode usá-los, mas
‫lembre-se de como na primeira etapa, poderíamos
‫ter realmente criado esta documentação usando um dos
‫ambientes, e provavelmente faríamos usamos o ambiente de
‫produção para isso e assim teríamos a URL de
‫produção final aqui na URL da API, certo?
‫De qualquer forma, é assim que
‫a documentação se parece, então aqui está o pedido de
‫exemplo e podemos alterá-lo também para o nosso próprio idioma.
‫Então, neste caso, Node JS, mas
‫se o usuário está, por exemplo, fazendo uma
‫solicitação usando jQuery, então ele pode apenas usar jQuery, ok.
‫Então, apenas para ver este exemplo de solicitação aqui, com o Node, é
‫algo parecido com isto.
‫Então, aqui nós temos todos os
‫nossos endpoints e você pode ver que aqueles que requerem
‫autenticação, eles realmente têm este ícone de cadeado aqui.
‫E então, em sua descrição, você pode adicionar o
‫ditado de que você precisa fazer login, a fim de acessar este
‫endpoint, e também como você pode realmente fazer login, ok.
‫Ou você também
‫pode descrever isso aqui na seção de autenticação, certo?
‫Então, idealmente, você teria descrições para tudo isso.
‫Ah, e aqui
‫vejo que esquecemos de substituir a senha real, mas
‫deixa pra lá, pois isso é apenas um exemplo, ok?
‫Mas é claro, você recebe todos
‫os pedidos que recebemos em nosso Postman também aqui.
‫Agora, outro recurso interessante aqui é executar o botão Postman, e
‫se alguém tiver o Postman instalado em seu
‫computador, tudo o que precisa
‫fazer é clicar aqui e abrir com o aplicativo Postman.
‫Agora, não vou fazer isso agora porque,
‫é claro, já o tenho em meu Postman, mas fora
‫isso, esse é um recurso muito bom para os usuários irem
‫em frente e começarem a experimentar sua API imediatamente.
‫Ok, e acho que é isso na
‫verdade, isso encerra nossa
‫seção e nossa API está finalmente concluída.
‫Então, novamente, parabéns por chegar tão longe
‫no curso, já
‫cobrimos muito terreno aqui juntos.
‫Agora, a seguir, há uma seção muito, muito emocionante
‫à frente, onde finalmente construiremos
‫a face do usuário para o site Natours.
‫Então, basicamente, vamos usar modelos para
‫criar um site totalmente dinâmico com base em todos os
‫dados que já temos em nosso banco de dados.
‫E isso é muito legal.
‫E mal posso esperar para mostrar isso a você.