Skip to content

Add Swagger UI API documentation with OpenAPI 3.0 #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Add Swagger UI API documentation with OpenAPI 3.0 #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3179c2
Initial plan
Copilot Jan 2, 2026
2c7265b
Add Swagger UI API documentation with OpenAPI annotations
Copilot Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
| ![Galaxy Info](logo.png) | Version 2 of the all-in-one solution to gathering and accessing information about Galaxy. |
| --- | --- |

## API Documentation

Interactive API documentation is available via Swagger UI at `/api-docs` when the server is running (e.g., `http://localhost:3000/api-docs`).

The API provides endpoints for:
- Ships and turrets data
- Kill logs and statistics
- Guild configuration
- Game constants
- Galaxypedia integration

## Development
### Getting Started
First, install dependencies with npm:
Expand Down
Loading