Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 5.61 KB

README.md

File metadata and controls

52 lines (43 loc) · 5.61 KB

Build Status Quality Gate Coverage

TibiaWikiApi

Gets data from http://tibia.wikia.com and exposes this data using a RESTful JSON API.

View online

Navigate to https://tibiawiki.dev to view the Swagger API of this project.

Run locally

Clone this git project to your local computer and compile it using: ./gradlew build from your favourite command line terminal. Then execute: ./gradlew bootRun and open your browser on http://localhost:8080

You can now access the REST resources using your browser or any REST client such as Postman or curl from your command line. E.g. navigating to http://localhost:8080/api/corpses should give you a list of corpses.

Query parameters

For all resources the query parameter ?expand=true can be appended to get a full list of JSON objects at the collection resource level. For example, instead of https://tibiawiki.dev/api/achievements the url https://tibiawiki.dev/api/achievements?expand=true can be used.

Resources

The following resources are available:

Entity List Example
Achievement achievements Goo Goo Dancer
Books books Dungeon Survival Guide (Book)
Buildings buildings Theater Avenue 8b
Charms charms Adrenaline Burst
Corpses corpses Dead Rat
Creatures creatures Dragon
Effects effects Blue Electricity Effect
Hunting Places hunting places Hero Cave
Items1 items Carlin Sword
Keys keys Key 4055
Locations locations Thais
Loot Statistics loot Ferumbras
Missiles missiles Throwing Cake Missile
Mounts mounts Donkey
NPCs npcs Sam
Objects1 objects Blueberry Bush
Outfits outfits Pirate Outfits
Quests quests The Paradox Tower Quest
Spells spells Light Healing
Streets streets Sugar Street

1 as of 2021 the categories Items and Objects were merged on the wiki. To be backwards compatible with systems relying on an accurate list of Items, this API now returns a list of 'Pickupable Items' from the Items endpoint, but which have the Object templateType.