A newer version of the Ed-Fi ODS / API is now available. See the Ed-Fi Technology Version Index for a link to the latest version.
Running the Postman Integration Tests
- Ian Christopher (Deactivated)
- Miguel Kaminski
Owned by Ian Christopher (Deactivated)
Mar 26, 2021
3 min read
Loading data...
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.
- Install and launch Postman.
- Set up an Environment for accessing the Ed-Fi ODS API.
- Download the following Postman environment file: Ed-Fi ODS API v3.x (Local).postman_environment.json.
- Click the Manage Environments button located in the upper right portion of the Postman window.
- Click the Import button on the subsequent Manage Environments dialog and import the supplied environment file.
- Modify the environment settings with your API client's key and secret (and ApiBaseUrl, if necessary).
- Ensure the environment is selected on the Postman window, as shown in the first image above.
- 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.
- Import one or more of the collections into Postman using the Import function located in the upper left corner of the Postman window.
- Run the tests using the Collection Runner.
- 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. - In the expanded user interface, click the Run button to launch the Collection Runner.
- In the Collection Runner dialog, ensure that the correct environment is selected and then click the Run button.
- Clicking the "expand" button in the top right area of the collection title bar.
- Monitor test execution and review the test results.
Downloads
The following GitHub link contains postman collection source: