【PowerShell】Invoke-RestMethod の使い方

はじめに

仕事で PowerShell を触る機会がありました。
そこで API 呼び出しに Invoke-RestMethod コマンドを利用したので、備忘録として記事に残します。

実行環境

• macOS Sonoma 14.3
• PowerShell 7.3.1

使い方

Invoke-RestMethod [-Uri] <Uri> [-Method <WebRequestMethod>]

オプションは色々とあるみたいですが、今回は -Uri と -Method のみ指定して実行します。
（仕事で利用したときは、認証トークンを渡すために -Headers も利用してました。）

実際に使ってみる

PokeAPI から 推しポケモンのエーフィの情報を取得してみます。

実行コマンド

Invoke-RestMethod -Method GET -Uri https://pokeapi.co/api/v2/pokemon/espeon

実行結果

abilities                : {@{ability=; is_hidden=False; slot=1}, @{ability=; i
                           s_hidden=True; slot=3}}
base_experience          : 184
forms                    : {@{name=espeon; url=https://pokeapi.co/api/v2/pokemo
                           n-form/196/}}
game_indices             : {@{game_index=196; version=}, @{game_index=196; vers
                           ion=}, @{game_index=196; version=}, @{game_index=196
                           ; version=}…}
height                   : 9
held_items               : {}
id                       : 196
is_default               : True
location_area_encounters : https://pokeapi.co/api/v2/pokemon/196/encounters
moves                    : {@{move=; version_group_details=System.Object[]}, @{
                           move=; version_group_details=System.Object[]}, @{mov
                           e=; version_group_details=System.Object[]}, @{move=;
                            version_group_details=System.Object[]}…}
name                     : espeon
order                    : 220
past_abilities           : {}
past_types               : {}
species                  : @{name=espeon; url=https://pokeapi.co/api/v2/pokemon
                           -species/196/}
sprites                  : @{back_default=https://raw.githubusercontent.com/Pok
                           eAPI/sprites/master/sprites/pokemon/back/196.png; ba
                           ck_female=; back_shiny=https://raw.githubusercontent
                           .com/PokeAPI/sprites/master/sprites/pokemon/back/shi
                           ny/196.png; back_shiny_female=; front_default=https:
                           //raw.githubusercontent.com/PokeAPI/sprites/master/s
                           prites/pokemon/196.png; front_female=; front_shiny=h
                           ttps://raw.githubusercontent.com/PokeAPI/sprites/mas
                           ter/sprites/pokemon/shiny/196.png; front_shiny_femal
                           e=; other=; versions=}
stats                    : {@{base_stat=65; effort=0; stat=}, @{base_stat=65; e
                           ffort=0; stat=}, @{base_stat=60; effort=0; stat=}, @
                           {base_stat=130; effort=2; stat=}…}
types                    : {@{slot=1; type=}}
weight                   : 265

問題なく情報を取得できました。

さいごに

今回は、PowerShellで Invoke-RestMethod を使った API 呼びだしを記事にしてみました。
誰かの役に立てば幸いです。