Começando a usar Postman com a API do Discourse

[supermathie (Michael Brown)]

Resumo

Postman é uma maneira de construir e testar facilmente requisições contra uma API.

Configurando com Discourse

1. Após abrir o Postman, clique em Create Workspace:

   

2. Escolha Blank workspace e clique em Next.

3. Título: Discourse API e selecione Create:

   

4. Clique em Collections:
   

   

5. Clique em Import:
   

   

6. Cole https://docs.discourse.org/openapi.json (que é a URL de "Download" mostrada em docs.discourse.org):
   

   

7. Escolha importar como Postman Collection:
   

   

Criar um novo Ambiente

1. Clique em Environments e Create Environment. Isso conterá variáveis específicas da instância que você está testando. Para este exemplo, usaremos try.discourse.org.

   • adicione uma nova variável: defaultHost com o valor try.discourse.org:
   • selecione o ambiente try.discourse.org no menu suspenso ⑤ Environment
   

Hello World!

Vamos tentar uma requisição!

1. Selecione Collections → categories.json → Retrieves a list of categories e clique em Send. Você deverá ver o resultado:
   
   

Adicionar autenticação às requisições

Para usar a API com autenticação de chave de API:

1. Adicione as seguintes variáveis a este ou a um novo ambiente:

   • api-username
   • api-key
   
   
   (seus valores devem, é claro, ser válidos para o site que você está consultando)

2. Adicione um script à coleção
   Selecione Collections → Discourse API Documentation → Scripts → Pre-request e cole o seguinte:

   pm.request.headers.add({
       key: "api-key",
       value: pm.variables.get("api-key")
   })
   pm.request.headers.add({
       key: "api-username",
       value: pm.variables.get("api-username")
   })