weihanli / dotnet-httpie Goto Github PK

View Code? Open in Web Editor NEW

27.0 3.0 2.0 567 KB

Amazing HTTP command-line tool powered by .NET, inspired by httpie

License: MIT License

C# 99.03% PowerShell 0.30% Shell 0.15% Dockerfile 0.52%

http http-cli httpie dotnet-tool rest curl

dotnet-httpie's Introduction

dotnet-HTTPie

Intro

dotnet tool version of httpie, Modern, user-friendly command-line HTTP client for the API era.

HTTPie (pronounced aitch-tee-tee-pie) is a command-line HTTP client. Its goal is to make CLI interaction with web services as human-friendly as possible. HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers.

Install

Install .NET SDK before you get started with this tool, when you had .NET SDK installed, run the command below to install the latest stable version tool

dotnet tool update --global dotnet-httpie

For latest preview version, run the following command instead:

dotnet tool update --global dotnet-httpie --prerelease

GetStarted

Now you can use the tool to call your API you want

Usages:

dotnet-http [flags] [METHOD] URL [ITEM [ITEM]]

There're three types of item

Type	Grammar
Query	name`==`test
Header	X-Api-Key`:`test
Request-Data	name`=`test, raw data field example(Only effective for JSON): age`:=`10, job`:=`'{"Id":1,"Name":"test"}'(Escape may needed for Windows cmd or Windows PowerShell)

Here's a sample:

dotnet-http https://reservation.weihanli.xyz/health test==1234 name=test age:=10 flag:=true job:='{"id": 1, "name": "test"}' api-key:Abc12345 --offline

More examples you may wanna have a look

dotnet-http :5000/api/values
dotnet-http localhost:5000/api/values
dotnet-http get https://reservation.weihanli.xyz/api/notice --body
dotnet-http /api/notice title=test body=test-body
dotnet-http post http://localhost/api/notice title=test body=test-body

Execute

You can execute *.http/*.rest http requests with the exec command

dotnet-http exec HttpStartedSample.http

dotnet-http exec ".\tests\HTTPie.IntegrationTest\TestAssets\HttpStartedSample.http"
dotnet-http exec ".\tests\HTTPie.IntegrationTest\TestAssets\HttpVariableSample.http"
dotnet-http exec ".\tests\HTTPie.IntegrationTest\TestAssets\HttpRequestReferenceSample.http"

see http request sample here: https://github.com/WeihanLi/dotnet-httpie/tree/dev/tests/HTTPie.IntegrationTest/TestAssets

Docker

There's a docker image(weihanli/dotnet-httpie) that you could use directly without installing the tool, use sample:

docker run --rm --pull=always weihanli/dotnet-httpie:latest http -v github.com

docker run --rm --pull=always weihanli/dotnet-httpie:latest http reservation.weihanli.xyz/health job:='{"id":1,"name":"tester"}' --offline

docker run --rm --pull=always weihanli/dotnet-httpie:latest http PUT httpbin.org hello=world

docker run --rm --pull=always weihanli/dotnet-httpie:latest http get httpbin.org/status/400

For detailed document: have a look at HTTPie documents https://httpie.io/docs#examples

References

httpie: https://github.com/httpie/httpie
httpie docs: https://httpie.io/docs
Curl to HTTPie request tool: https://curlipie.now.sh/

dotnet-httpie's People

Contributors

Stargazers

Watchers

Forkers

watch-later xkrof

dotnet-httpie's Issues

Extension to copy request as a HTTPie request

Browser extension for copy request as a httpie request

More http file support

See https://devblogs.microsoft.com/visualstudio/safely-use-secrets-in-http-requests-in-visual-studio-2022/

env:

env file
user env file
custom config provider

variable

dotenv
processEnv

contributes to #64

Load test exporter

Support for load test exporter to export load test result to different output

json
influxdb
...

Authentication support

Add authentication schemes support for simplified authentication

Basic Auth
JWT Bearer Token

https://httpie.io/docs#authentication
https://github.com/teracyhq/httpie-jwt-auth

Unexpected header attach

Describe the bug

 dotnet-http https://auth.docker.io/token X-Docker-Token:true service==registry.docker.io scope=="repository:weihanli/mdni
ce:pull" -v
GET /token?service=registry.docker.io&scope=repository:weihanli/mdnice:pull HTTP/1.1
Host: auth.docker.io
Schema: https
scope==repository: weihanli/mdnice:pull
User-Agent: dotnet-HTTPie/0.6.1
X-Docker-Token: true
X-dotnet-HTTPie-RequestTimestamp: 10/16/2022 11:06:53 +08:00                                                                                                                                                                                                                            HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 16 Oct 2022 03:06:54 GMT
Strict-Transport-Security: max-age=31536000
Transfer-Encoding: chunked
X-dotnet-HTTPie-Duration: 1607.883ms
X-dotnet-HTTPie-ResponseTimestamp: 10/16/2022 11:06:54 +08:00
x-trace-id: 2ff2273a606f8514030862a3ac9c3bfd

Header not attached

Describe the bug

Header not attached

To Reproduce

dotnet-http -v "http://localhost:6200/api/Calculation/V1/OrderSubscribe/preview" Pref:'{"crs":0,"ctc":"KR","crc":"KRW","lac":"zh-CN","storeid":0,"som":"kilograms"}' --offline

Expected behavior

Pref header should be attached

Screenshots

Additional context

version: 0.5.1

Add `execute` subcommand

http #64

# execute http request
dotnet-http exec demo.http

curl #51

dotnet-http exec `curl text` -t curl

Har support #52

dotnet-http exec xx.har --type har

Proxy support

Is your feature request related to a problem? Please describe.

Send requests with a proxy

Convert from HAR file

Is your feature request related to a problem? Please describe.

Similar to #51 , sometimes we may wanna generate request from a har file

Describe alternatives you've considered

dotnet-httpie convert <xxx.har>

`-h` bug

Describe the bug

To Reproduce

dotnet-http -h

Expected behavior

Output the helps info

Download file support

Download feature

https://httpie.io/docs/cli/download-mode

Reduce the docker image size

Reduce the docker image size with compressed self-contained and maybe more less size

https://docs.microsoft.com/en-us/dotnet/core/deploying/single-file?WT.mc_id=DT-MVP-5004222#publish-a-single-file-app---sample-project-file

Load test support

Is your feature request related to a problem? Please describe.

Load test feature, iteration, concurrent use etc ...

P90, P95, etc

Input

Iteration
Duration
Virtual users

Output

Total requests
Success/fail requests
request per seconds
duration average/P99/P95/P90/P50

Additional context

request data not work as expected when use `:=`

Describe the bug

dotnet-http https://reservation.weihanli.xyz/health test==1234 name=test age:=10 flag:=true job:='{"id": 1, "name": "test"}' --offline --debug

0.7.1

Named Session support

See details https://httpie.io/docs#named-sessions

Usage examples:

# Create session named user1
http --session=user1 -a user1:password pie.dev/get X-Foo:Bar

# Refer to the session by its name 
http --session=user1 pie.dev/get

# To create or reuse a different session, simple specify a different name
http --session=user2 -a user2:password pie.dev/get X-Bar:Foo

download checksum validate

add support for validating the checksum hash value

new options

checksum
checksum-alg(md5/sha1/sha128/sha256...)

Convert from curl request script

Is your feature request related to a problem? Please describe.

It would be great to support

Describe the solution you'd like

Parse curl request
Generate the httpie request

Additional context

System.ArgumentOutOfRangeException in QueryStringMiddleware

Describe the bug

dotnet-http post http://localhost/api/notice title=test body=test-body --debug

0.7.0

Nested JSON support

Is your feature request related to a problem? Please describe.

It would help us use complex json more easily

http pie.dev/post \
  platform[name]=HTTPie \
  platform[about][mission]='Make APIs simple and intuitive' \
  platform[about][homepage]=httpie.io \
  platform[about][homepage]=httpie.io \
  platform[about][stars]:=54000 \
  platform[apps][]=Terminal \
  platform[apps][]=Desktop \
  platform[apps][]=Web \
  platform[apps][]=Mobile

{
    "platform": {
        "name": "HTTPie",
        "about": {
            "mission": "Make APIs simple and intuitive",
            "homepage": "httpie.io",
            "stars": 54000
        },
        "apps": [
            "Terminal",
            "Desktop",
            "Web",
            "Mobile"
        ]
    }
}

Additional context

https://httpie.io/docs/cli/nested-json

http API test support

Testing spec

environment
collection(request collection)
group(request group in a collection)
request(specific request)
variable

collectionName: testCollection
  variables:
    - name: value

  - groupName: testGroup
      variables:
        - name: value
      - requestName: hello request
        variables:
          - name: value      
        assertion: "$response.EnsureSuccessStatusCode()"

Invalid request when the authorization header end with `==`

Describe the bug

Invalid request when the authorization header end with ==

To Reproduce

> dotnet-http :5000/api/values Authorization:'Basic xxxx==' --offline

GET /api/values?Authorization:Basic%20xxxx= HTTP/1.1
Host: localhost:5000
Schema: http
User-Agent: dotnet-HTTPie/0.6.2

> dotnet-http :5000/api/values 'Authorization:Basic xxxx==' --offline

GET /api/values?Authorization:Basic%20xxxx= HTTP/1.1
Host: localhost:5000
Schema: http
User-Agent: dotnet-HTTPie/0.6.2

Expected behavior

GET /api/values HTTP/1.1
Host: localhost:5000
Schema: http
Authorization: Basic xxx==
User-Agent: dotnet-HTTPie/0.6.2

File download bug

Describe the bug

Http response header sample

Content-Disposition: attachment; filename="hello-0.0.1.tgz"; filename*=UTF-8''hello-0.0.1.tgz

behavior

The download file name should be hello-0.0.1.tgz, currenly it's '"hello-0.0.1.tgz"; filename*=UTF-8'\'''\''hello-0.0.1.tgz'

Additional context

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition

Invalid request behavior when there's query string in the request URL

Describe the bug

When there's query string in the request URL, wrong HTTP method fired

To Reproduce

Steps to reproduce the behavior:

http get "https://reservation.weihanli.xyz/health?Page=1&Platform=3&Module=homepageBannerPrimary&Language=en-US&Country=CN&track=newLangTest" -v

Output

POST /health?Page=1&Platform=3&Module=homepageBannerPrimary&Language=en-US&Country=CN&track=newLangTest HTTP/1.1
Host: reservation.weihanli.xyz
Schema: https
Content-Type: application/json;charset=utf-8
User-Agent: dotnet-HTTPie/0.1.1

{"https://reservation.weihanli.xyz/health?Page":"1&Platform=3&Module=homepageBannerPrimary&Language=en-US&Country=CN&track=newLangTest"}

HTTP/1.1 200 OK
Connection: keep-alive
Date: Tue, 10 Aug 2021 08:04:11 GMT
Server: nginx/1.14.1
Transfer-Encoding: chunked

healthy

Expected behavior

Send HTTP GET request without a request body

Additional context

Version: 0.1.1-preview-20210804-003845

weihanli / dotnet-httpie Goto Github PK

dotnet-httpie's Introduction

dotnet-HTTPie

Intro

Install

GetStarted

Execute

Docker

More

References

dotnet-httpie's People

Contributors

Stargazers

Watchers

Forkers

dotnet-httpie's Issues

Add execute subcommand

http #64

curl #51

Har support #52

Testing spec

Recommend Projects

Recommend Topics

Recommend Org

Add `execute` subcommand