Iniziare a usare Postman con l'API di Discourse

[supermathie (Michael Brown)]

Riepilogo

Postman è un modo per costruire e testare facilmente richieste contro un’API.

Configurazione con Discourse

1. Dopo aver aperto Postman, fai clic su Crea area di lavoro:

   

2. Scegli Area di lavoro vuota e fai clic su Avanti.

3. Titola l’area di lavoro API Discourse e seleziona Crea:

   

4. Fai clic su Collezioni:
   

   

5. Fai clic su Importa:
   

   

6. Incolla https://docs.discourse.org/openapi.json (che è l’URL “Download” mostrato su docs.discourse.org):
   

   

7. Scegli di importare come Collezione Postman:
   

   

Crea un nuovo Ambiente

1. Fai clic su Ambienti e Crea Ambiente. Questo conterrà variabili specifiche dell’istanza che stai testando. Per questo esempio, useremo try.discourse.org.

   • aggiungi una nuova variabile: defaultHost con il valore try.discourse.org:
   • seleziona l’ambiente try.discourse.org dal menu a discesa ⑤ Ambiente
   

Ciao Mondo!

Proviamo una richiesta!

1. Seleziona Collezioni → categories.json → Recupera un elenco di categorie e fai clic su Invia. Dovresti vedere il risultato:
   
   

Aggiungi autenticazione alle richieste

Per utilizzare l’API con autenticazione tramite chiave API:

1. Aggiungi le seguenti variabili a questo o a un nuovo ambiente:

   • api-username
   • api-key
   
   
   (i loro valori devono ovviamente essere validi per il sito che stai interrogando)

2. Aggiungi uno script alla collezione
   Seleziona Collezioni → Documentazione API Discourse → Script → Pre-richiesta e incolla quanto segue:

   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")
   })