Running the Postman Integration Tests

The Ed-Fi ODS / API includes several collections of Postman tests that can be executed against a sample ODS sandbox API endpoint.

The following instructions assume that you already have an API client configured with access to an Ed-Fi ODS / API backed by the sample Ed-Fi ODS database.

1. Install and launch Postman.
2. Set up an Environment for accessing the Ed-Fi ODS API.
   1. Download the following Postman environment file: Ed-Fi ODS API v3.x (Local).postman_environment.json.
   2. Click the Manage Environments button located in the upper right portion of the Postman window.
      
   3. Click the Import button on the subsequent Manage Environments dialog and import the supplied environment file.
   4. Modify the environment settings with your API client's key and secret (and ApiBaseUrl, if necessary).
      
   5. Ensure the environment is selected on the Postman window, as shown in the first image above.
3. Locate (or download) the Ed-Fi ODS Integration Test Suite collections from the Ed-Fi-ODS GitHub repository. See the downloads section on the right for GitHub link. 
4. Import one or more of the collections into Postman using the Import function located in the upper left corner of the Postman window.
   
5. Run the tests using the Collection Runner.
   1. Clicking the "expand" button in the top right area of the collection title bar.
      Note: The button will only appear after hovering with the mouse.
      
   2. In the expanded user interface, click the Run button to launch the Collection Runner.
      
   3. In the Collection Runner dialog, ensure that the correct environment is selected and then click the Run button.
      
6. Monitor test execution and review the test results.