LukeParke/pokemonAPI-Amari
1
0
Fork 0
mirror of https://github.com/LukeHagar/pokemonAPI-Amari.git synced 2025-12-06 04:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

added open api documentation

Browse Source
This commit is contained in:
Amari Bolmer
2024-10-25 12:58:32 -07:00
parent 442169521f
commit f5c9370062
1 changed files with 87 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
poke_sdk/openapi.yaml Normal file
View File

@@ -0,0 +1,87 @@
openapi: 3.0.0
info:
title: PokeAPI SDK
description: A Python SDK for interacting with the PokeAPI, providing access to Pokémon data and generations.
version: 1.0.0
servers:
- url: https://pokeapi.co/api/v2
paths:
/pokemon/{identifier}:
get:
summary: Get Pokémon by name or ID
parameters:
- name: identifier
in: path
required: true
description: The name or ID of the Pokémon to retrieve.
schema:
type: string
responses:
'200':
description: Successful response with Pokémon data
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: pikachu
id:
type: integer
example: 25
types:
type: array
items:
type: string
example: electric
'404':
description: Pokémon not found
content:
application/json:
schema:
type: object
properties:
detail:
type: string
example: "Not found"
/generation/{id}:
get:
summary: Get generation by ID or name
parameters:
- name: id
in: path
required: true
description: The ID or name of the generation to retrieve.
schema:
type: string
responses:
'200':
description: Successful response with generation data
content:
application/json:
schema:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: generation-i
pokemon_species:
type: array
items:
type: string
example: bulbasaur
'404':
description: Generation not found
content:
application/json:
schema:
type: object
properties:
detail:
type: string
example: "Not found"