Skip to content

Add Swagger/OpenAPI 3.0 docs and interactive Swagger UI for Thomas REST API #1055

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/OpenAPI 3.0 docs and interactive Swagger UI for Thomas REST API #1055

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
7f996e6
Initial plan
Copilot May 1, 2026
706008f
Add Swagger/OpenAPI 3.0 documentation for Thomas REST API
Copilot May 1, 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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@

### Go to [the website](https://iheartradio.github.io/thomas/) for documentation.

## API Documentation (Swagger UI)

When the server is running, interactive API documentation is available at:

```
http://localhost:8080/swagger-ui
```

The machine-readable OpenAPI 3.0 spec is served at:

```
http://localhost:8080/swagger/openapi.yaml
```


## Copyright and License

Expand Down
Loading