[PowerShell] Invoke-RestMethod, Invoke-WebRequest

Linux

[PowerShell] Invoke-RestMethod, Invoke-WebRequest

carsumin 2024. 4. 30. 09:48

https://www.truesec.com/hub/blog/invoke-webrequest-or-invoke-restmethod

Invoke-WebRequest or Invoke-RestMethod? - Trulysuper

Learn when it's appropriate to use either Invoke-WebRequest or Invoke-RestMethod.

www.truesec.com

Invoke-RestMethod

RESTful 웹 서비스와 상호작용하는 데 사용되는 cmdlet이다

웹 API를 호출하고 JSON 또는 XML 형식의 데이터를 쉽게 처리할 수 있다

GET, POST, PUT, DELETE 등의 HTTP 메서드를 지원하며 웹 서비스와의 통신을 간편하게 한다

기본사용법

Invoke-RestMethod -Uri <URI> [-Method <Method>] [-Body <Body>] [-Headers <Headers>] [-ContentType <ContentType>]

-Uri : 요청할 API의 URI
-Method : HTTP 메서드로 기본값은 GET
-Body : 요청에 포함할 데이터로 주로 POST나 PUT 요청 시 사용됨
-Headers : 요청에 포함할 HTTP 헤더
-ContentType : 요청 본문의 콘텐츠 타입으로 기본값은 'application/json'

1. GET 요청

Github API 호출하려 PowerShell Repository 정보 가져옴

$url = "https://api.github.com/repos/PowerShell/PowerShell"
$response = Invoke-RestMethod -Uri $url
$response | Format-List

2. POST 요청

JSONPlaceholder API를 사용하여 새로운 포스트를 생성하는 POST 요청을 보냄

'ConvertTo-Json' cmdlet 사용하여 해시테이블을 JSON 형식으로 변환

$url = "https://jsonplaceholder.typicode.com/posts"
$body = @{
    title = "foo"
    body = "bar"
    userId = 1
} | ConvertTo-Json

$response = Invoke-RestMethod -Uri $url -Method Post -Body $body -ContentType "application/json"
$response

3. PUT 요청

$url = "https://jsonplaceholder.typicode.com/posts/1"
$body = @{
    id = 1
    title = "foo"
    body = "bar"
    userId = 1
} | ConvertTo-Json

$response = Invoke-RestMethod -Uri $url -Method Put -Body $body -ContentType "application/json"
$response

4. DELETE 요청

$url = "https://jsonplaceholder.typicode.com/posts/1"
Invoke-RestMethod -Uri $url -Method Delete

HTTP 헤더 추가

HTTP 헤더를 추가하여 요청을 더 상세하게 설정할 수 있다

인증 토큰을 헤더에 포함하려면 아래와 같이 할 수 있다

$url = "https://api.example.com/secure-data"
$headers = @{
    Authorization = "Bearer your_access_token"
}

$response = Invoke-RestMethod -Uri $url -Headers $headers
$response

Invoke-WebRequest

웹 요청을 보내고 응답을 수신하는데 사용되는 cmdlet이다

웹 페이지의 콘텐츠를 가져오거나 파일을 다운로드하거나 REST API와 상호작용하는 등의 작업을 수행할 수 있다

HTTP 및 HTTPS 프로토콜을 지원하며 다양한 HTTP 메서드를 사용할 수 있다

기본 구문

Invoke-WebRequest -Uri <URI> [-Method <Method>] [-Body <Body>] [-Headers <Headers>] [-ContentType <ContentType>] [-OutFile <FilePath>]

-Uri : 요청할 API의 URI
-Method : HTTP 메서드로 기본값은 GET
-Body : 요청에 포함할 데이터로 주로 POST나 PUT 요청 시 사용됨
-Headers : 요청에 포함할 HTTP 헤더
-ContentType : 요청 본문의 콘텐츠 타입으로 기본값은 'application/json'
-OutFile : 응답 내용을 파일로 저장

1. GET 요청

웹 페이지의 내용을 가져와서 출력함

응답은 'HtmlWebResponseObject' 객체로 반환되며, 'Content' 속성을 통해 HTML 내용을 확인할 수 있다

$url = "https://www.example.com"
$response = Invoke-WebRequest -Uri $url
$response.Content

2. POST 요청

$url = "https://httpbin.org/post"
$body = @{
    name = "John Doe"
    email = "john.doe@example.com"
}

$response = Invoke-WebRequest -Uri $url -Method Post -Body $body -ContentType "application/x-www-form-urlencoded"
$response.Content

3. 파일 다운로드

지정된 URL에서 파일을 다운로드하여 로컬에 저장

$url = "https://example.com/file.zip"
$output = "C:\path\to\file.zip"
Invoke-WebRequest -Uri $url -OutFile $output

4. 헤더 추가

사용자 정의 헤더를 추가하여 API를 호출

$url = "https://api.example.com/data"
$headers = @{
    "Authorization" = "Bearer your_access_token"
    "Custom-Header" = "CustomValue"
}

$response = Invoke-WebRequest -Uri $url -Headers $headers
$response.Content

5. 폼 데이터 전송

$url = "https://httpbin.org/post"
$form = @{
    field1 = "value1"
    field2 = "value2"
}

$response = Invoke-WebRequest -Uri $url -Method Post -Form $form
$response.Content

HTTP 응답 처리

StatusCode : HTTP 상태 코드 (예: 200, 404, 500 등)
StatusDescription : 상태 코드에 대한 설명
Content : 응답 본문
Headers : 응답 헤더
RawContent : 원시 응답 데이터
Links : HTML 문서의 링크 컬렉션
Forms : HTML 폼 컬렉션
ParsedHtml : HTML 문서의 파싱된 객체

$url = "https://www.example.com"
$response = Invoke-WebRequest -Uri $url

# 응답 상태 코드
$response.StatusCode

# 응답 헤더
$response.Headers

# 응답 본문
$response.Content

저작자표시 비영리 변경금지 (새창열림)

'Linux' 카테고리의 다른 글

[Linux] 사용중인 포트 종료하기 (Port Kill) (0)	2024.11.27

현재글[PowerShell] Invoke-RestMethod, Invoke-WebRequest

carsumin devlog 🍀