From c1ebceb23b08b93bab4a335ab2160ffaf10ef808 Mon Sep 17 00:00:00 2001 From: Josh Habdas Date: Tue, 30 Apr 2024 10:54:25 -0400 Subject: [PATCH] docs: update running to include api docs --- docs/getting-started/running/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/getting-started/running/index.md b/docs/getting-started/running/index.md index 949442df63..8925c70138 100644 --- a/docs/getting-started/running/index.md +++ b/docs/getting-started/running/index.md @@ -30,6 +30,10 @@ Next login to the application with: You can use any email that the system has in its loaded test data. The "password" is actually a role name. Most of the time you will want to use `SUPER` which is just an alias for all the roles. +# API Documentation + +With server running locally, API documentation is available at [http://localhost:8080/swagger-ui/index.html](http://localhost:8080/swagger-ui/index.html). This documentation is generated by Micronaut and provides a way to interact with the API directly from the browser. + # Running the UI The UI will be available on port 8080 once the application is running. The UI is served from the `web-ui` directory. The UI is built using Vite, a modern build tool for frontend development. The UI is written in JavaScript and uses React and Vitest.