1
00:00:01,100 --> 00:00:04,510
‫Narrador: Então, nossa API está basicamente concluída.

2
00:00:04,510 --> 00:00:07,003
‫E então, neste vídeo

3
00:00:07,003 --> 00:00:09,680
‫final da seção, vamos criar rapidamente

4
00:00:09,680 --> 00:00:13,020
‫a documentação da API diretamente no Postman.

5
00:00:13,020 --> 00:00:15,290
‫E isso mesmo, podemos

6
00:00:15,290 --> 00:00:18,830
‫criar facilmente alguma documentação rápida direto no Postman.

7
00:00:18,830 --> 00:00:21,620
‫E é muito importante ter a documentação da

8
00:00:21,620 --> 00:00:25,870
‫API em vigor porque é assim que nos comunicamos com os membros da

9
00:00:25,870 --> 00:00:29,140
‫equipe, ou mesmo com os usuários finais da API, como

10
00:00:29,140 --> 00:00:31,740
‫eles podem realmente usá-la na prática.

11
00:00:31,740 --> 00:00:33,973
‫Deixe-me mostrar como funciona.

12
00:00:35,490 --> 00:00:38,367
‫Agora, antes que possamos realmente criar a documentação,

13
00:00:38,367 --> 00:00:40,920
‫vamos apenas fazer uma limpeza aqui.

14
00:00:40,920 --> 00:00:45,010
‫Por exemplo, livre-se deste pedido, certo?

15
00:00:47,550 --> 00:00:51,490
‫Outra coisa que eu quero fazer é aqui no ponto

16
00:00:51,490 --> 00:00:55,180
‫de login, nós realmente expomos nossa senha aqui.

17
00:00:55,180 --> 00:00:58,220
‫E isso não é uma boa ideia, então o que

18
00:00:58,220 --> 00:01:00,350
‫vou fazer é criar uma variável de

19
00:01:00,350 --> 00:01:02,320
‫ambiente que vai manter essa senha.

20
00:01:02,320 --> 00:01:06,100
‫Como é sempre igual, não deve haver problema.

21
00:01:06,100 --> 00:01:07,833
‫Portanto, lembre-se de como fazemos isso.

22
00:01:09,920 --> 00:01:12,730
‫Bem, viemos aqui para gerenciar o

23
00:01:13,970 --> 00:01:16,903
‫meio ambiente e aqui simplesmente adicionamos outro.

24
00:01:17,960 --> 00:01:19,807
‫Então, senha, test1234.

25
00:01:23,820 --> 00:01:28,820
‫E aqui não está correto, então senha, atualizada, e agora vamos fazer

26
00:01:30,220 --> 00:01:31,860
‫o mesmo aqui na

27
00:01:31,860 --> 00:01:33,363
‫produção também.

28
00:01:35,440 --> 00:01:37,297
‫Então, senha, test1234.

29
00:01:41,020 --> 00:01:46,020
‫E então, não adicionar, mas vamos fechar isso e

30
00:01:46,590 --> 00:01:51,120
‫aqui agora posso adicionar e usar isso,

31
00:01:51,120 --> 00:01:55,003
‫não em uma string, mas assim.

32
00:01:56,840 --> 00:01:58,490
‫Portanto, senha.

33
00:01:58,490 --> 00:01:59,633
‫Então, vamos tentar isso.

34
00:02:00,980 --> 00:02:04,620
‫E isso nos dá um erro estranho, mas

35
00:02:04,620 --> 00:02:07,840
‫nossa senha está realmente aqui, então provavelmente

36
00:02:07,840 --> 00:02:12,313
‫o que precisamos fazer é realmente colocar as aspas aqui.

37
00:02:13,360 --> 00:02:14,680
‫Então, vamos tentar isso.

38
00:02:14,680 --> 00:02:17,740
‫E agora, de fato, estamos logados com sucesso.

39
00:02:17,740 --> 00:02:21,090
‫Então salve isso agora, ok?

40
00:02:21,090 --> 00:02:23,990
‫E agora o que devemos fazer é realmente

41
00:02:23,990 --> 00:02:26,290
‫criar uma descrição para cada pedido que

42
00:02:26,290 --> 00:02:28,150
‫temos em nossa coleção.

43
00:02:28,150 --> 00:02:30,120
‫Claro que não vou fazer

44
00:02:30,120 --> 00:02:33,173
‫isso, vou apenas exemplificar aqui com o primeiro.

45
00:02:34,270 --> 00:02:35,103
‫OK?

46
00:02:36,630 --> 00:02:39,250
‫Então, vamos fechar esses

47
00:02:39,250 --> 00:02:42,840
‫outros e agora podemos adicionar uma descrição.

48
00:02:42,840 --> 00:02:46,350
‫E então vamos apenas dizer, use este ponto

49
00:02:49,150 --> 00:02:52,403
‫de extremidade para criar um novo passeio.

50
00:02:53,530 --> 00:02:58,514
‫Ok, e novamente, agora você deve fazer exatamente a mesma coisa

51
00:02:58,514 --> 00:03:03,030
‫para todas as suas solicitações se seu objetivo for realmente

52
00:03:03,030 --> 00:03:06,170
‫publicar e compartilhar sua API, certo?

53
00:03:06,170 --> 00:03:09,633
‫Então a mesma coisa se aplica às pastas,

54
00:03:11,130 --> 00:03:14,300
‫e não para renomear, mas para editar.

55
00:03:14,300 --> 00:03:15,900
‫E assim, em cada

56
00:03:15,900 --> 00:03:18,870
‫uma dessas pastas, também podemos adicionar uma descrição.

57
00:03:18,870 --> 00:03:23,380
‫Então, digamos algo aleatório como, você pode

58
00:03:23,380 --> 00:03:27,093
‫obter todos os passeios, criar

59
00:03:27,960 --> 00:03:29,463
‫novos

60
00:03:31,400 --> 00:03:34,743
‫e editar e excluir passeios.

61
00:03:36,580 --> 00:03:41,000
‫Existem também terminais especiais para alguns

62
00:03:42,630 --> 00:03:44,763
‫requisitos especiais.

63
00:03:46,170 --> 00:03:48,680
‫Ok, isso é totalmente aleatório

64
00:03:48,680 --> 00:03:52,350
‫e eu publicaria algo assim para minha própria API,

65
00:03:52,350 --> 00:03:56,100
‫mas aqui realmente queremos apenas testar como funciona, ok?

66
00:03:56,100 --> 00:03:57,540
‫Como você pode ver

67
00:03:57,540 --> 00:04:00,800
‫aqui embaixo, você também pode usar o Mark aqui, ok?

68
00:04:00,800 --> 00:04:03,240
‫Então, por exemplo, para deixar o texto

69
00:04:03,240 --> 00:04:06,273
‫em negrito, você pode pensar que funciona assim, sim,

70
00:04:07,820 --> 00:04:09,920
‫parece que sim, e então

71
00:04:09,920 --> 00:04:13,523
‫sim, você pode fazer todos os tipos de coisas aqui, ok?

72
00:04:15,970 --> 00:04:18,730
‫Provavelmente, você também

73
00:04:18,730 --> 00:04:21,500
‫pode criar uma descrição

74
00:04:21,500 --> 00:04:26,363
‫no próprio Natours, então digamos que a API

75
00:04:30,950 --> 00:04:35,950
‫Natours contém endpoints para passeios, usuários e avaliações.

76
00:04:37,790 --> 00:04:39,510
‫E, novamente, um monte

77
00:04:39,510 --> 00:04:42,500
‫de coisas, como você poderia descrever seu processo

78
00:04:42,500 --> 00:04:45,320
‫de autenticação, ou suas permissões e realmente tudo

79
00:04:45,320 --> 00:04:48,820
‫que o usuário precisa saber para usar esta API, ok?

80
00:04:48,820 --> 00:04:50,510
‫Portanto, você deve

81
00:04:50,510 --> 00:04:54,060
‫sempre adicionar uma descrição a todas as solicitações, a todas

82
00:04:54,060 --> 00:04:57,490
‫as pastas e também, é claro, à própria coleção.

83
00:04:57,490 --> 00:05:01,510
‫Ah, e podemos realmente descrever os parâmetros de consulta em uma string

84
00:05:01,510 --> 00:05:03,943
‫de consulta, então vamos fazer isso aqui.

85
00:05:09,634 --> 00:05:13,384
‫E também podemos dizer que ele suporta

86
00:05:14,620 --> 00:05:19,620
‫maior que, menor que igual, maior que e menor que operadores.

87
00:05:23,070 --> 00:05:24,890
‫Então, novamente, apenas um exemplo

88
00:05:26,070 --> 00:05:28,490
‫aqui e vamos salvá-lo agora na solicitação.

89
00:05:28,490 --> 00:05:30,580
‫E com isso, acho que devemos

90
00:05:30,580 --> 00:05:33,700
‫estar prontos para realmente publicar nossa documentação de API.

91
00:05:33,700 --> 00:05:36,750
‫E então, para fazer isso, vamos apenas ir

92
00:05:36,750 --> 00:05:39,910
‫aqui para a opção de coleções e, em

93
00:05:39,910 --> 00:05:42,070
‫seguida, publicar aqui as documentações.

94
00:05:42,070 --> 00:05:45,400
‫E então isso deve abrir uma janela do navegador, e

95
00:05:45,400 --> 00:05:47,830
‫para mim isso aconteceu fora da

96
00:05:47,830 --> 00:05:50,570
‫minha tela, então deixe-me pegar isso aqui.

97
00:05:50,570 --> 00:05:53,700
‫E agora você pode escolher o ambiente.

98
00:05:53,700 --> 00:05:57,200
‫Então aqui devemos ter uma lista de nossos ambientes, o

99
00:05:57,200 --> 00:06:01,470
‫que por algum motivo não temos, isso é estranho, mas de qualquer

100
00:06:01,470 --> 00:06:05,060
‫maneira, não queríamos usar nenhum ambiente de qualquer maneira, porque

101
00:06:05,060 --> 00:06:06,540
‫isso substituiria nossas variáveis

102
00:06:06,540 --> 00:06:09,340
‫de ambiente por seus valores reais, e não

103
00:06:09,340 --> 00:06:10,460
‫queremos isso.

104
00:06:10,460 --> 00:06:12,620
‫Por exemplo, usamos a variável de

105
00:06:12,620 --> 00:06:14,620
‫ambiente na senha, para

106
00:06:14,620 --> 00:06:17,900
‫que posteriormente na documentação não fique realmente visível, ok?

107
00:06:17,900 --> 00:06:20,313
‫Portanto, realmente não queremos usar nenhum ambiente.

108
00:06:21,270 --> 00:06:23,280
‫Agora também podemos usar

109
00:06:23,280 --> 00:06:27,610
‫um domínio personalizado, mas isso é apenas para usuários pagos, certo?

110
00:06:27,610 --> 00:06:30,740
‫Então, também poderíamos alterar todo o estilo da

111
00:06:30,740 --> 00:06:34,410
‫API para combiná-lo com as cores da sua marca, mas,

112
00:06:34,410 --> 00:06:37,260
‫novamente, isso não é necessário neste

113
00:06:37,260 --> 00:06:40,620
‫caso e, portanto, vamos em frente e publicá-lo.

114
00:06:40,620 --> 00:06:42,550
‫E agora, isso é realmente

115
00:06:42,550 --> 00:06:46,367
‫público, para que todos possam ver sua documentação agora neste URL.

116
00:06:47,480 --> 00:06:51,300
‫Agora, por algum motivo, ele realmente não atualizou todas as mudanças que

117
00:06:51,300 --> 00:06:54,653
‫acabamos de fazer antes, o que é um pouco estranho.

118
00:06:55,510 --> 00:06:58,420
‫Então, vamos voltar ao Postman e ver

119
00:06:58,420 --> 00:07:00,090
‫o que está acontecendo.

120
00:07:00,090 --> 00:07:04,510
‫Talvez tenha a ver com essa coisa rotativa aqui, então vou apenas

121
00:07:04,510 --> 00:07:07,158
‫encerrar o Postman e abri-lo novamente.

122
00:07:07,158 --> 00:07:09,393
‫E vamos esperar que isso corrija isso.

123
00:07:12,610 --> 00:07:15,060
‫Então, se recarregarmos aqui,

124
00:07:15,060 --> 00:07:18,720
‫ahh, teremos todas as nossas alterações aqui.

125
00:07:18,720 --> 00:07:20,980
‫Veja, a descrição que

126
00:07:20,980 --> 00:07:23,620
‫adicionamos para a coleção Natours, certo?

127
00:07:23,620 --> 00:07:26,830
‫Em seguida, também a descrição para esta pasta

128
00:07:26,830 --> 00:07:29,530
‫e a descrição para esta solicitação.

129
00:07:29,530 --> 00:07:32,180
‫E por fim, como

130
00:07:32,180 --> 00:07:35,400
‫primeira descrição, também para esse parâmetro, ok?

131
00:07:35,400 --> 00:07:39,477
‫Aqui, obtemos a variável de ambiente do URL em

132
00:07:39,477 --> 00:07:41,850
‫vez do URL real.

133
00:07:41,850 --> 00:07:44,310
‫Agora, é claro, você pode querer realmente fornecer

134
00:07:44,310 --> 00:07:46,320
‫a URL real aqui e,

135
00:07:46,320 --> 00:07:48,443
‫para isso, pode simplesmente usar outro ambiente.

136
00:07:50,150 --> 00:07:53,170
‫Então, aqui em cima você pode ver

137
00:07:53,170 --> 00:07:57,060
‫todos os ambientes, mas eles são privados, então agora ninguém

138
00:07:57,060 --> 00:07:58,720
‫pode usá-los, mas

139
00:07:58,720 --> 00:08:01,430
‫lembre-se de como na primeira etapa, poderíamos

140
00:08:01,430 --> 00:08:04,760
‫ter realmente criado esta documentação usando um dos

141
00:08:04,760 --> 00:08:07,990
‫ambientes, e provavelmente faríamos usamos o ambiente de

142
00:08:07,990 --> 00:08:11,350
‫produção para isso e assim teríamos a URL de

143
00:08:11,350 --> 00:08:14,543
‫produção final aqui na URL da API, certo?

144
00:08:15,440 --> 00:08:18,064
‫De qualquer forma, é assim que

145
00:08:18,064 --> 00:08:21,530
‫a documentação se parece, então aqui está o pedido de

146
00:08:21,530 --> 00:08:24,940
‫exemplo e podemos alterá-lo também para o nosso próprio idioma.

147
00:08:24,940 --> 00:08:27,840
‫Então, neste caso, Node JS, mas

148
00:08:27,840 --> 00:08:31,020
‫se o usuário está, por exemplo, fazendo uma

149
00:08:31,020 --> 00:08:34,770
‫solicitação usando jQuery, então ele pode apenas usar jQuery, ok.

150
00:08:34,770 --> 00:08:39,290
‫Então, apenas para ver este exemplo de solicitação aqui, com o Node, é

151
00:08:39,290 --> 00:08:40,793
‫algo parecido com isto.

152
00:08:42,870 --> 00:08:45,213
‫Então, aqui nós temos todos os

153
00:08:45,213 --> 00:08:48,400
‫nossos endpoints e você pode ver que aqueles que requerem

154
00:08:48,400 --> 00:08:51,400
‫autenticação, eles realmente têm este ícone de cadeado aqui.

155
00:08:51,400 --> 00:08:54,299
‫E então, em sua descrição, você pode adicionar o

156
00:08:54,299 --> 00:08:57,960
‫ditado de que você precisa fazer login, a fim de acessar este

157
00:08:57,960 --> 00:09:01,060
‫endpoint, e também como você pode realmente fazer login, ok.

158
00:09:01,060 --> 00:09:02,760
‫Ou você também

159
00:09:02,760 --> 00:09:06,290
‫pode descrever isso aqui na seção de autenticação, certo?

160
00:09:06,290 --> 00:09:09,243
‫Então, idealmente, você teria descrições para tudo isso.

161
00:09:10,360 --> 00:09:11,948
‫Ah, e aqui

162
00:09:11,948 --> 00:09:15,770
‫vejo que esquecemos de substituir a senha real, mas

163
00:09:15,770 --> 00:09:19,940
‫deixa pra lá, pois isso é apenas um exemplo, ok?

164
00:09:19,940 --> 00:09:22,040
‫Mas é claro, você recebe todos

165
00:09:22,040 --> 00:09:24,933
‫os pedidos que recebemos em nosso Postman também aqui.

166
00:09:26,900 --> 00:09:30,780
‫Agora, outro recurso interessante aqui é executar o botão Postman, e

167
00:09:30,780 --> 00:09:33,830
‫se alguém tiver o Postman instalado em seu

168
00:09:33,830 --> 00:09:36,380
‫computador, tudo o que precisa

169
00:09:36,380 --> 00:09:40,000
‫fazer é clicar aqui e abrir com o aplicativo Postman.

170
00:09:40,000 --> 00:09:42,490
‫Agora, não vou fazer isso agora porque,

171
00:09:42,490 --> 00:09:45,830
‫é claro, já o tenho em meu Postman, mas fora

172
00:09:45,830 --> 00:09:49,270
‫isso, esse é um recurso muito bom para os usuários irem

173
00:09:49,270 --> 00:09:52,253
‫em frente e começarem a experimentar sua API imediatamente.

174
00:09:54,070 --> 00:09:57,370
‫Ok, e acho que é isso na

175
00:09:57,370 --> 00:09:59,330
‫verdade, isso encerra nossa

176
00:09:59,330 --> 00:10:02,610
‫seção e nossa API está finalmente concluída.

177
00:10:02,610 --> 00:10:06,440
‫Então, novamente, parabéns por chegar tão longe

178
00:10:06,440 --> 00:10:08,720
‫no curso, já

179
00:10:08,720 --> 00:10:11,140
‫cobrimos muito terreno aqui juntos.

180
00:10:11,140 --> 00:10:14,230
‫Agora, a seguir, há uma seção muito, muito emocionante

181
00:10:14,230 --> 00:10:16,460
‫à frente, onde finalmente construiremos

182
00:10:16,460 --> 00:10:19,260
‫a face do usuário para o site Natours.

183
00:10:19,260 --> 00:10:21,510
‫Então, basicamente, vamos usar modelos para

184
00:10:21,510 --> 00:10:24,770
‫criar um site totalmente dinâmico com base em todos os

185
00:10:24,770 --> 00:10:27,810
‫dados que já temos em nosso banco de dados.

186
00:10:27,810 --> 00:10:29,380
‫E isso é muito legal.

187
00:10:29,380 --> 00:10:32,053
‫E mal posso esperar para mostrar isso a você.