go_dnd5eapi

README

go-dnd5eapi

A go client for interacting with the dnd5eapi.

Install

go get github.com/kjkondratuk/go-dnd5eapi

Create a client

Simply:

client := godnd5eapi.NewApiClient("<Base URL Here>"))

Or, create a client with a client with a custom config:

myCustomClient := &http.Client{
    // ... custom client options here ...
}

client := godnd5eapi.NewApiClient("<Base URL Here>", godnd5eapi.WithHttpClient(myCustomClient))

Supported Endpoints

(Work-in-progress)

Endpoint	Fully Implemented	Partially Implemented	Not Implemented
endpoints	X	-	-
-------------------------------	---	---	---
ability-scores	-	X	-
classes	-	X	-
classes-proficiency-rel	-	X	-
damage-types	-	X	-
equipment	-	X	-
languages	-	X	-
proficiencies	-	X	-
races	-	X	-
skills	-	X	-
skill-ability-rel	-	X	-
subclasses	-	X	-
traits	-	X	-
-------------------------------	---	---	---
conditions	-	-	-
equipment-categories	-	-	-
features	-	-	-
magic-schools	-	-	-
monsters	-	-	-
spellcasting	-	-	-
spells	-	-	-
starting-equipment	-	-	-
subraces	-	-	-
weapon-properties	-	-	-

Documentation

Index

• type Client
  • func NewClient(basicsProvider api.BasicsProvider) *Client

Types

type Client

type Client struct {
	AbilityScores      ability_scores.AbilityScoreClient
	Classes            classes.ClassClient
	ClassProficiencies classes_proficiency_rel.ClassProficiencyRelClient
	Conditions         conditions.ConditionClient
	Damage             damage_types.DamageTypeClient
	Endpoints          endpoints.EndpointsClient
	Equipment          equipment.EquipmentClient
	Features           features.FeatureClient
	Languages          languages.LanguageClient
	MagicSchools       magic_schools.MagicSchoolClient
	Monsters           monsters.MonsterClient
	Proficiencies      proficiencies.ProficiencyClient
	Races              races.RaceClient
	Skills             skills.SkillClient
	Subclasses         subclasses.SubclassClient
	Traits             traits.TraitClient
	// contains filtered or unexported fields
}

func NewClient

func NewClient(basicsProvider api.BasicsProvider) *Client