Testing API endpoints

• Prerequisites
• How-to test any new API endpoints with Postman
• How to authenticate requests in Postman
  • Prerequisites
  • Instructions

Prerequisites

1. Postman

How-to test any new API endpoints with Postman

1. Ensure that you deployed your changes to staging within your PR (read more here).

2. Inside of Postman, hit the Import button near the top left:

   

3. Inside the input box, enter the following link:

   https://stg.codebloom.patinanetwork.org/v3/api-docs
   
   # or if you're testing things locally
   http://localhost:8080/v3/api-docs
   
   # or prod
   https://codebloom.patinanetwork.org/v3/api-docs
   

   

4. Once it finishes importing the OpenAPI spec, hit View Import Settings and set Folder organization to Tags:

   

5. You can then hit Import and rename the new collection to indicate the environment (e.g. Codebloom dev or Codebloom stg)

   

How to authenticate requests in Postman

Note

These instructions require Google Chrome (or any Chromium based browser)

Prerequisites

1. Install Postman Interceptor here

Instructions

1. Log into Postman Interceptor with the same account that you used to authenticate on your local Postman instance.

2. Swap to the Sync Cookie tab

   

3. Enter in stg.codebloom.patinanetwork.org (or local/prod) into the domain list

   

4. Hit Sync Cookies

   

5. Navigate to stg.codebloom.patinanetwork.org (or local/prod) and log in as you normally would (if you are logged in, log out then log back in).

6. Once authenticated, Postman Interceptor will automatically copy your authentication cookie to your local Postman client, and you can now hit endpoints under your user!