README
¶
Auctioneer
API Methods 🚀
| Route | Expected result |
|---|---|
/api/v1/auc_search?item_name={{string}}®ion={{string}}&realm_name={{string}} |
The result of the search for the requested item |
/api/v1/item_media/{{int}} |
Awailable media for requested item ID |
auc search query params |
Description |
|---|---|
item_name *required |
Name of item to search |
region *required |
Region of realm. Choose eu or us |
realm_name *required |
Name of realm in the region |
Getting Started 👲
- Clone project
- Create a new branch from origin/main
- Do
go mod downloadin the root directory - Make the magic
- Push branch and create merge request
- Be happy with the results and do it again from the beginning
Local Development 🚧
Export environment variables for example:
AUCTIONEER_BLIZZARD_EU_API_URL = "https://eu.api.blizzard.com"
AUCTIONEER_BLIZZARD_US_API_URL = "https://us.api.blizzard.com"
AUCTIONEER_BLIZZARD_AUTH_URL = "https://us.battle.net/oauth/token"
AUCTIONEER_BLIZZARD_CLIENT_SECRET = "your_client_secret"
AUCTIONEER_BLIZZARD_CLIENT_ID = "your_client_id"
AUCTIONEER_APP_PORT = ":8000"
AUCTIONEER_LOG_LEVEL = "DEBUG"
Helpful Links 🤔
Directories
Click to show internal directories.
Click to hide internal directories.