Add a basic API page #6
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Geoffrey Biggs <[email protected]>
Kernald
reviewed
Oct 19, 2025
| ``` | ||
|
|
||
| :::warning[Security warning] | ||
| If your Booklore instance is exposed on the public Internet, be careful about exposing the API port. |
There was a problem hiding this comment.
Note that with the default configuration, most of the API is publicly exposed anyway. The issue is that accessing the swagger documentation doesn't fall under /api, and paths outside of this one are not forwarded to the back-end, but to the front-end. Any actual API endpoint (or rather, anything under /api) is publicly accessible already through the 6060 port.
| To get an API token you can use, you will need to sniff the requests being made by your web browser. | ||
| Open the Booklore UI in your web browser and log in as an administrator user. | ||
| Then, open the web developer tools for your browser. | ||
| In Firefox and Google Chrome, this is done using the keyboard shortcut `Ctrl-Shift-I`. |
herobrauni
reviewed
Nov 7, 2025
| Once the API is exposed, you can access the live API documentation at the following URL. | ||
|
|
||
| ``` | ||
| http://localhost:8080/swagger-ui/index.html |
There was a problem hiding this comment.
This seems to be no longer the correct url.
On version v1.10.0 its under:
:6060/api/v1/swagger-ui/index.html
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the start of a page about using the API. It describes how to expose the API, where to find the live documentation, and how to get an API token; the API token information will need to be replaced when BookLore gains the ability to generate API tokens.