Skip to content

dofusdude/dodugo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go API client for dodugo

A project for you - the developer.

The all-in-one toolbelt for your next Ankama related project.

Client SDKs

  • Javascript npm i dofusdude-js --save
  • Typescript npm i dofusdude-ts --save
  • Go go get -u github.com/dofusdude/dodugo
  • Python pip install dofusdude
  • PHP
  • Java Maven with GitHub packages setup

Everything, including this site, is generated out of the Docs Repo. Consider it the Single Source of Truth. If there is a problem with the SDKs, create an issue there.

Your favorite language is missing? Please let me know!

Main Features

  • 🥷 Seamless Auto-Update load data in the background when a new Dofus version is released and serving it within 10 minutes with atomic data source switching. No downtime and no effects for the user, just always up-to-date.

  • Blazingly Fast all data in-memory, aggressive caching over short time spans, HTTP/2 multiplexing, written in Go, optimized for low latency, hosted on bare metal in 🇩🇪.

  • 📨 Discord Integration Ankama related RSS and Almanax feeds to post to Discord servers with advanced features like filters or mentions. Use the endpoints as a dev or the official Web Client as a user.

  • 🩸 Dofus 2 Beta from stable to bleeding edge by replacing /dofus2 with /dofus2beta.

  • 🗣️ Multilingual supporting en, fr, es, pt including the dropped languages from the Dofus website de and it.

  • 🧠 Search by Relevance allowing typos in name and description, handled by language specific text analysis and indexing.

  • 🕵️ Complete actual data from the game including items invisible to the encyclopedia like quest items.

  • 🖼️ HD Images rendering game assets to high-res images with up to 800x800 px.

... and much more on the Roadmap on my Discord.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 0.9.0
  • Package version: 1.0.0
  • Generator version: 7.6.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://discord.gg/3EtHskZD8h

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import dodugo "github.com/dofusdude/dodugo"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value dodugo.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), dodugo.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value dodugo.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), dodugo.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using dodugo.ContextOperationServerIndices and dodugo.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), dodugo.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), dodugo.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.dofusdu.de

Class Method HTTP request Description
AlmanaxAPI GetAlmanaxDate Get /dofus2/{language}/almanax/{date} Single Almanax Date
AlmanaxAPI GetAlmanaxRange Get /dofus2/{language}/almanax Almanax Range
ConsumablesAPI GetAllItemsConsumablesList Get /{game}/{language}/items/consumables/all List All Consumables
ConsumablesAPI GetItemsConsumablesList Get /{game}/{language}/items/consumables List Consumables
ConsumablesAPI GetItemsConsumablesSearch Get /{game}/{language}/items/consumables/search Search Consumables
ConsumablesAPI GetItemsConsumablesSingle Get /{game}/{language}/items/consumables/{ankama_id} Single Consumables
CosmeticsAPI GetAllCosmeticsList Get /{game}/{language}/items/cosmetics/all List All Cosmetics
CosmeticsAPI GetCosmeticsList Get /{game}/{language}/items/cosmetics List Cosmetics
CosmeticsAPI GetCosmeticsSearch Get /{game}/{language}/items/cosmetics/search Search Cosmetics
CosmeticsAPI GetCosmeticsSingle Get /{game}/{language}/items/cosmetics/{ankama_id} Single Cosmetics
EquipmentAPI GetAllItemsEquipmentList Get /{game}/{language}/items/equipment/all List All Equipment
EquipmentAPI GetItemsEquipmentList Get /{game}/{language}/items/equipment List Equipment
EquipmentAPI GetItemsEquipmentSearch Get /{game}/{language}/items/equipment/search Search Equipment
EquipmentAPI GetItemsEquipmentSingle Get /{game}/{language}/items/equipment/{ankama_id} Single Equipment
GameAPI GetGameSearch Get /{game}/{language}/search Game Search
GameAPI GetItemsAllSearch Get /{game}/{language}/items/search Search All Items
MetaAPI GetGameSearchTypes Get /dofus2/meta/search/types Available Game Search Types
MetaAPI GetMetaAlmanaxBonuses Get /dofus2/meta/{language}/almanax/bonuses Available Almanax Bonuses
MetaAPI GetMetaAlmanaxBonusesSearch Get /dofus2/meta/{language}/almanax/bonuses/search Search Available Almanax Bonuses
MetaAPI GetMetaElements Get /dofus2/meta/elements Effects and Condition Elements
MountsAPI GetAllMountsList Get /{game}/{language}/mounts/all List All Mounts
MountsAPI GetMountsList Get /{game}/{language}/mounts List Mounts
MountsAPI GetMountsSearch Get /{game}/{language}/mounts/search Search Mounts
MountsAPI GetMountsSingle Get /{game}/{language}/mounts/{ankama_id} Single Mounts
QuestItemsAPI GetAllItemsQuestList Get /{game}/{language}/items/quest/all List All Quest Items
QuestItemsAPI GetItemQuestSingle Get /{game}/{language}/items/quest/{ankama_id} Single Quest Items
QuestItemsAPI GetItemsQuestList Get /{game}/{language}/items/quest List Quest Items
QuestItemsAPI GetItemsQuestSearch Get /{game}/{language}/items/quest/search Search Quest Items
ResourcesAPI GetAllItemsResourcesList Get /{game}/{language}/items/resources/all List All Resources
ResourcesAPI GetItemsResourceSearch Get /{game}/{language}/items/resources/search Search Resources
ResourcesAPI GetItemsResourcesList Get /{game}/{language}/items/resources List Resources
ResourcesAPI GetItemsResourcesSingle Get /{game}/{language}/items/resources/{ankama_id} Single Resources
SetsAPI GetAllSetsList Get /{game}/{language}/sets/all List All Sets
SetsAPI GetSetsList Get /{game}/{language}/sets List Sets
SetsAPI GetSetsSearch Get /{game}/{language}/sets/search Search Sets
SetsAPI GetSetsSingle Get /{game}/{language}/sets/{ankama_id} Single Sets
WebhooksAPI DeleteWebhooksAlmanaxId Delete /webhooks/almanax/{id} Unregister Almanax Hook
WebhooksAPI DeleteWebhooksRssId Delete /webhooks/rss/{id} Unregister RSS Hook
WebhooksAPI DeleteWebhooksTwitterId Delete /webhooks/twitter/{id} Unregister Twitter Hook
WebhooksAPI GetMetaWebhooksAlmanax Get /meta/webhooks/almanax Get Almanax Hook Metainfo
WebhooksAPI GetMetaWebhooksRss Get /meta/webhooks/rss Get RSS Hook Metainfo
WebhooksAPI GetMetaWebhooksTwitter Get /meta/webhooks/twitter Get Twitter Hook Metainfo
WebhooksAPI GetWebhooksAlmanaxId Get /webhooks/almanax/{id} Get Almanax Hook
WebhooksAPI GetWebhooksRssId Get /webhooks/rss/{id} Get RSS Hook
WebhooksAPI GetWebhooksTwitterId Get /webhooks/twitter/{id} Get Twitter Hook
WebhooksAPI PostWebhooksAlmanax Post /webhooks/almanax Register Almanax Hook
WebhooksAPI PostWebhooksRss Post /webhooks/rss Register RSS Hook
WebhooksAPI PostWebhooksTwitter Post /webhooks/twitter Register Twitter Hook
WebhooksAPI PutWebhooksAlmanaxId Put /webhooks/almanax/{id} Update Almanax Hook
WebhooksAPI PutWebhooksRssId Put /webhooks/rss/{id} Update RSS Hook
WebhooksAPI PutWebhooksTwitterId Put /webhooks/twitter/{id} Update Twitter Hook

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

stelzo@steado.de