api client tools
You can user Swagger to interact with the API. First you must launch the application. If you start it in the Visual Studio Code debugger, you can use the following link to access Swagger: http://localhost:5000/swagger/.
Otherwise, you can connect using {{baseUrl}}/swagger/
Once the Swagger page is loaded, you will see of listing of all available operations for each REST API endpoint. The user interface gives you the opportunity to interact with and execute each opeation.
You can use Postman to interact with the REST API.
Follow the steps below in order to install and configure Postman for use with the reference-architecture-api REST API.
| Step | Description | Further Instructions |
|---|---|---|
| 1 | First you must install Postman. | Install Postman |
| 2 | Import custom collections and environments. You will want to import all of the files located in the repository's /postman folder. | Import Collections |
| 3 | Select an operation from the collection | |
| 4 | Select an environment from the drop-down | Select Environment |
Once Postman is properly configured, the Collections pane will included a Reference Architectue collection that contains Categories nad Notes folders; each of which contain several REST API operations. Additionally, there are operations in the collection root. You can execute any of these operations by (1) choosing the target environment from the environment drop-down, and then (2) selecting the opeation, and then (3) clicking the Send button. Obviously, you need to ensure that the REST API is running in the selected environment.