Inspiration
With the rise in usage of microservices, Making http requests is essential job of most devs. For these, there are multiple options like curl, insomnia postman. My Ideal choice is to use curl but problems with it is, having no history and no easy way to save and rerun. Postman solves that problem, but once user logs in(earlier it used to be optional, now its mandatory), it stores all request metadata(body/headers/urls/credentails) to their servers although it helps solve using it across multiple devices, backup but it could be potential security loop hole if they can access it. (now a days, postman desktop is super slow also).
This project aims to solve save&reuse requests, maintaining history and no sync in proprietery servers (although you can achive sync via commiting http files into git).
GOAL
dothttp will provide simple, cleaner architecture for making http requests. It uses xtext (eclipse developed dsl) to build a custom dsl.
Documentation
More information or docs can be cound at https://docs.dothttp.dev
Go through this example for better understanding. for babysteps click here
# users.http
#!/usr/bin/env /home/prasanth/cedric05/dothttp/dist/dothttp-cli
# this is comment
// this is also a comment
/*
this is multi line
comment
*/
# http file can have multiple requests, name tag/annotation is used to identify
@name("fetch 100 users, skip first 50")
# makes are get request, with url `https://req.dothttp.dev/user`
GET https://req.dothttp.dev/user
# below is an header example
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
# below is how you set url params '?' --> signifies url quary param
? ("fetch", "100") #
? ("skip", "50")
? projection, name
? projection, org
? projection, location
# makes are post request, with url `https://req.dothttp.dev/user`
POST https://req.dothttp.dev/user
basicauth('username', 'password')
/*
below defines payload for the post request.
json --> signifies payload is json data
*/
json({
"name": "{{name=adam}}", # name is templated, if spcified via env or property, it will be replaced
"org": "dothttp",
"location": "Hyderabad",
# "interests": ["exploring", "listening to music"],
})
# makes put request, with url `https://req.dothttp.dev/user/1`
PUT https://req.dothttp.dev/post
# define headers in .dothttp.json with env
basicauth("{{username}}, "{{password}}")
# posts with urlencoded
data({
"name": "Adam A",
"org": "dothttp",
"location": "Hyderabad",
"interests": ["exploring", "listening to music"],
})
// or use below one
// data('name=Adam+A&org=dothttp&location=Hyderabad&interests=%5B%27exploring%27%2C+%27listening+to+music%27%5D')
KICKSTART
From pypi
pip install dothttp-req==0.0.10
From source
git clone git@github.com:cedric05/dothttp.git
cd dothttp
python3 -m pip install pipenv
pipenv install
python3.9
python3 -m dothttp examples/dothttpazure.http
docker
docker build -t dothttp .
docker run -it --rm dothttp
whalebrew
docker run -it --rm dothttp
Features
- easy and cleaner http syntax
- variable substitution with property file
- generates curl from http for easy sharing
docker build -t dothttp .
whalebrew install dothttp
dothttp examples/dothttpazure.http
First DotHttpRequest and more
GET "http://localhost:8000/get"
dothttp get.http or python -m dothttp get.http
Run
dothttp simple.http
prints
{
"args": {},
"headers": {
"Accept-Encoding": "identity",
"Host": "httpbin.org",
"User-Agent": "python-urllib3/1.26.3",
"X-Amzn-Trace-Id": "Root=1-6022266a-20fb552e530ba3d90c75be6d"
},
"origin": "117.216.243.24",
"url": "http://localhost:8000/get"
}
POST request
POST "http://localhost:8000/post"
{
"args": {},
"data": "",
"files": {},
"form": {},
"headers": {
"Accept-Encoding": "identity",
"Content-Length": "0",
"Host": "httpbin.org",
"User-Agent": "python-urllib3/1.26.3",
"X-Amzn-Trace-Id": "Root=1-602228fa-3c3ed5213b6d8c2d2a223148"
},
"json": null,
"origin": "117.216.243.24",
"url": "http://localhost:8000/post"
}
similarly, other methodsGET, POST, OPTIONS, DELETE, CONNECT, PUT, HEAD, TRACE support is available.
Query
query params can be added to request by specifying
query ( "key", "value")
? "key", "value"
? "key": "value"
? "key"= "value"
all four are accepted. going with query("hi", "hi2) is more readable. ?"key"= "value" is more concise
Payload
user can specify payload by mentioning below four forms (for various scenarios).
-
data("ram")user can also mention its
content-typewithdata("ram", "text/plain") -
data({"key": "value"})for form input. -
json({"key": "value"})for json payload. -
fileinput("path/to/file", "type")uploads file as payload (type is optional). -
files(("photo", "path/to/file/photo.jpg", "image/jpeg"), ("photo details", '{"name":"prasanth"}', "application/json") )for multipart upload dothttp will figure out content type by going through file/data, when type is not mentioned.
Comments
dothttp will use # for commenting entire line.
//line comment. follows java, javascript#line comment. follows python's comment style/* */multi line comment. follows java/javascript style
Templating
POST 'http://localhost:8000/post'
? ("{{key}}", "{{value}}")
data('{"{{key}}" :"{{value}}"}', 'application/json')
- specify variable values through property file (sample.json).
-
user can define environments and can activate multiple environments at a time
-
dothttp by default will read variables from
"*"section -
for example
dothttp --property-file path/to/file.json --env ram chandrawill activate
*section properties,ramsection properties andchandrasection propertiesdothttp --env ram chandrawill activate*section properties,ramsection properties andchandrasection properties from.dothttp.jsonin httpfile name space
-
- through command line
dothttp --property key=ram value=rangawill replace{{ram}}torangafrom the file - through file itself. (will be helpful for default properties)
POST 'https://{{host=httpbin.org}}/post'
Headers
User can define headers in below three formats
header('content-type', 'application/json')readable'content-type': 'application/json'concise- property file
headerssection from property-file can also be used. in most scenarios, headers section will be common for a host. having them in property file would ease them.
Authentication
BasicAuth
basicauth('username','password')' --> will compute add respective headers.
DigestAuth
digestauth('username','password')' --> will compute add respective headers.
NtlmAuth
ntlmauth('username','password')' --> will compute add respective headers.
Property file
{
"*": {
"host": "httpbin.org"
},
"headers": {
"content-type": "plain/text"
},
"preprod": {
"host": "preprod.httpbin.org"
}
}
Special sections in property file
*section in property file will be activated once user specifies property file if user didn't specifiy file and.dothttp.jsonexists, it will be activatedheadersonce a property file is activated. headers from property file will be added to request by default without user having to specify in.httpfile
Formatter (experimental phase)
dothttp can format a http file using below command
dothttp -fmt examples/dothttpazure.http --experimental
or
dothttp --format examples/dothttpazure.http --experimental
to print to command line
dothttp --format examples/dothttpazure.http --experimental --stdout
Editor support
syntax highlighting for visual studio code is supported via dothttp-code
Command line options
usage: dothttp [-h] [--curl] [--property-file PROPERTY_FILE] [--no-cookie] [--env ENV [ENV ...]] [--debug] [--info] [--format] [--stdout]
[--property PROPERTY [PROPERTY ...]]
file
http requests for humans
optional arguments:
-h, --help show this help message and exit
general:
--curl generates curl script
--no-cookie, -nc cookie storage is disabled
--debug, -d debug will enable logs and exceptions
--info, -i more information
file http file
property:
--property-file PROPERTY_FILE, -p PROPERTY_FILE
property file
--env ENV [ENV ...], -e ENV [ENV ...]
environment to select in property file. properties will be enabled on FIFO
--property PROPERTY [PROPERTY ...]
list of property's
format:
--format, -fmt formatter
--stdout print to commandline
checkout examples
Vscode alternatives
- rest-client written in typescript
- httpYac written in typescript
- Thunder Client closed source
Non Vscode alternatives
- http-client closed source
- dothttp written in python
1 maintainer
Metadata
1 maintainer
Release files for dothttp-req 0.0.43
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dothttp_req-0.0.43.tar.gz | 88.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dothttp_req-0.0.43-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 188.1 kB
Release files / dothttp_req-0.0.43.tar.gz
| Download URL | dothttp_req-0.0.43.tar.gz |
|---|---|
| Size | 88.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fd94e1f2f142aa23bdc312a40f68da1ecf05b63ccf150fe8b4d55277d19f8b70
|
|
BLAKE2b-256 checksum How to use checksums |
52f5a9e1271156536fa771bb5111224ea62bb8f2d4c74a08d81a1c2bb185ace8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 25, 2024.
Transparency logRelease files / dothttp_req-0.0.43-py3-none-any.whl
| Download URL | dothttp_req-0.0.43-py3-none-any.whl |
|---|---|
| Size | 99.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0c847fe52af0b03093c3fe64cb3c3b12d93a98521f275a1d921cd6c48eb555ab
|
|
BLAKE2b-256 checksum How to use checksums |
9a35ca44d500456b31b92e666e3c23a74f095dc69fe6b09bc881e55f42d9cfe4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 25, 2024.
Transparency log
