go_dnd5eapi

README

go-dnd5eapi

A go client for interacting with the dnd5eapi. This is a first-pass at a go client with minimal dependencies, so there will likely be plenty of bugs at this stage--PRs are welcome.

Install

go get github.com/kjkondratuk/go-dnd5eapi

Create a client

Simply:

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

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

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

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

Sample Calls

Check out the examples in the examples folder!

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
	SkillsAbility      skills_ability_rel.SkillAbilityRelClient
	Spellcasting       spellcasting.SpellcastingClient
	Spells             spells.SpellClient
	StartingEquipment  starting_equipment.StartingEquipmentClient
	Subclasses         subclasses.SubclassClient
	Subraces           subraces.SubraceClient
	Traits             traits.TraitClient
	WeaponProperties   weapon_properties.WeaponPropertiesClient
	// contains filtered or unexported fields
}

func NewClient

func NewClient(basicsProvider api.BasicsProvider) *Client