package
0.0.0-20230909132605-02d10c156e9a
Repository: https://github.com/dominicbarnes/pokeapi-clients.git
Documentation: pkg.go.dev

# README

Go API Server for openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

To see how to make this your own, look here:

README

Running the server

To run the server, follow these simple steps:

go run main.go

To run the server in a docker container

docker build --network=host -t openapi .

Once the image is built, just run

docker run --rm -it openapi

Known Issue

Endpoints sharing a common path may result in issues. For example, /v2/pet/findByTags and /v2/pet/:petId will result in an issue with the Gin framework. For more information about this known limitation, please refer to gin-gonic/gin#388 for more information.

A workaround is to manually update the path and handler. Please refer to gin-gonic/gin/issues/205#issuecomment-296155497 for more information.

# Functions

AbilityList - .
AbilityRead - .
BerryFirmnessList - .
BerryFirmnessRead - .
BerryFlavorList - .
BerryFlavorRead - .
BerryList - .
BerryRead - .
CharacteristicList - .
CharacteristicRead - .
ContestEffectList - .
ContestEffectRead - .
ContestTypeList - .
ContestTypeRead - .
EggGroupList - .
EggGroupRead - .
EncounterConditionList - .
EncounterConditionRead - .
EncounterConditionValueList - .
EncounterConditionValueRead - .
EncounterMethodList - .
EncounterMethodRead - .
EvolutionChainList - .
EvolutionChainRead - .
EvolutionTriggerList - .
EvolutionTriggerRead - .
GenderList - .
GenderRead - .
GenerationList - .
GenerationRead - .
GrowthRateList - .
GrowthRateRead - .
Index is the index handler.
ItemAttributeList - .
ItemAttributeRead - .
ItemCategoryList - .
ItemCategoryRead - .
ItemFlingEffectList - .
ItemFlingEffectRead - .
ItemList - .
ItemPocketList - .
ItemPocketRead - .
ItemRead - .
LanguageList - .
LanguageRead - .
LocationAreaList - .
LocationAreaRead - .
LocationList - .
LocationRead - .
MachineList - .
MachineRead - .
MoveAilmentList - .
MoveAilmentRead - .
MoveBattleStyleList - .
MoveBattleStyleRead - .
MoveCategoryList - .
MoveCategoryRead - .
MoveDamageClassList - .
MoveDamageClassRead - .
MoveLearnMethodList - .
MoveLearnMethodRead - .
MoveList - .
MoveRead - .
MoveTargetList - .
MoveTargetRead - .
NatureList - .
NatureRead - .
NewRouter returns a new router.
PalParkAreaList - .
PalParkAreaRead - .
PokeathlonStatList - .
PokeathlonStatRead - .
PokedexList - .
PokedexRead - .
PokemonColorList - .
PokemonColorRead - .
PokemonFormList - .
PokemonFormRead - .
PokemonHabitatList - .
PokemonHabitatRead - .
PokemonList - .
PokemonRead - .
PokemonShapeList - .
PokemonShapeRead - .
PokemonSpeciesList - .
PokemonSpeciesRead - .
RegionList - .
RegionRead - .
StatList - .
StatRead - .
SuperContestEffectList - .
SuperContestEffectRead - .
TypeList - .
TypeRead - .
VersionGroupList - .
VersionGroupRead - .
VersionList - .
VersionRead - .

# Structs

Route is the information for every URI.

# Type aliases

Routes is the list of the generated Route.