tesla
▼
Project version
v1.14.1
v1.14.0
v1.13.2
v1.13.1
v1.13.0
v1.12.3
v1.12.2
v1.12.1
v1.12.0
v1.11.2
v1.11.1
v1.11.0
v1.10.3
v1.10.2
v1.10.1
v1.10.0
v1.9.0
v1.8.1
v1.8.0
v1.7.0
v1.6.1
v1.6.0
v1.5.1
v1.5.0
v1.4.4
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.1
v1.2.0
v1.1.0
v1.0.0
v1.0.0-beta.1
v0.10.0
v0.9.0
v0.8.0
v0.7.2
v0.7.1
v0.7.0
v0.6.0
v0.5.2
v0.5.1
v0.5.0
v0.3.6
v0.3.5
v0.3.4
v0.3.3
v0.3.2
v0.3.1
v0.2.2
v0.2.1
v0.1.5
v0.1.4
v0.1.1
v0.1.0
GUIDES
Modules
API Reference
Modules
Tesla
Getting started
What to do next?
Sponsors
License
Explanations
Client
Creating a Client
Single-Client (Singleton) Pattern
Multi-Client Pattern
Comparing Single-Client and Multi-Client Patterns
Testing
Should I Use Mox or Tesla.Mock?
References
Middleware
Writing Middleware
Production-Ready Middleware Pipeline Example
Adapter
Writing an Adapter
Setting the Adapter
Adapter Options
About :httpc adapter and security issues
Cheatsheets
Basic Cheat Sheet
Making Requests 101
Streaming
Middleware
Adapter
How-To's
Migrate from v0 to v1
Returning Tuple Result from HTTP Functions
Dropped aliases support (#159)
Dropped local middleware/adapter functions (#171)
Dropped client as function (#176)
Headers are now a list (#160)
Dropped support for Elixir 1.3 (#164)
Adapter options need to be wrapped in :adapter key:
DebugLogger merged into Logger (#150)
Jason is the new default JSON library (#175)
Migrate away from v1 Macro
Test Using Mox
1. Define a Mock Adapter
2. Configure the Mock Adapter for Tests
3. Set Up Mocking in Your Tests
4. Run Your Tests
Tesla
Sections
Building API client
Direct usage
Default adapter
Summary
Types
encoding_strategy/0
option/0
Functions
build_adapter/1
build_client/2
build_url/1
build_url/3
client/2
delete/3
delete!/3
delete_header/2
encode_query/2
get/3
get!/3
get_header/2
get_headers/2
head/3
head!/3
options/3
options!/3
patch/4
patch!/4
post/4
post!/4
put/4
put!/4
put_body/2
put_header/3
put_headers/2
put_opt/3
request/2
request!/2
run/2
run_default_adapter/2
trace/3
trace!/3
Tesla.Client
Summary
Types
adapter/0
middleware/0
t/0
Functions
adapter/1
middleware/1
Tesla.Env
Sections
Fields
Summary
Types
body/0
client/0
headers/0
method/0
opts/0
param/0
query/0
result/0
runtime/0
stack/0
status/0
t/0
url/0
Tesla.Mock
Sections
Setup
Examples
Setting up mocks
Global mocks
Summary
Types
response_opt/0
response_opts/0
Functions
call/2
json/2
mock/1
mock_global/1
text/2
Tesla.Multipart
Sections
Examples
Summary
Types
part_stream/0
part_value/0
t/0
Functions
add_content_type_param/2
add_field/4
add_file/3
add_file_content/4
new/0
Tesla.Multipart.Part
Summary
Types
t/0
Tesla.Test
Summary
Functions
assert_received_tesla_call/3
assert_tesla_empty_mailbox/0
assert_tesla_env/3
expect_tesla_call/1
html/2
json/2
text/2
Behaviours
Tesla.Adapter
Sections
Writing custom adapter
Summary
Types
options/0
Callbacks
call/2
Functions
opts/3
Tesla.Middleware
Sections
Middleware options
Ordering
Writing custom middleware
Summary
Callbacks
call/3
Adapters
Tesla.Adapter
.Finch
Sections
Examples
Adapter specific options
Finch options
.Gun
Sections
Examples
Adapter specific options
Gun options
Summary
Functions
close/1
read_chunk/3
.Hackney
Sections
Examples
Adapter specific options
.Httpc
.Ibrowse
Sections
Examples
.Mint
Sections
Examples
Adapter specific options:
Summary
Functions
close/1
read_chunk/3
Middlewares
Tesla.Middleware
.BaseUrl
Sections
Examples
.BasicAuth
Sections
Examples
Options
.BearerAuth
Sections
Examples
Options
.CompressRequest
.Compression
Sections
Examples
Options
Summary
Functions
compress/2
decompress/1
.DecodeFormUrlencoded
.DecodeJson
.DecodeMessagePack
Summary
Functions
call/3
.DecodeRels
Sections
Examples
.DecompressResponse
.DigestAuth
Sections
Examples
Options
.EncodeFormUrlencoded
.EncodeJson
.EncodeMessagePack
Summary
Functions
call/3
.FollowRedirects
Sections
Examples
Options
.FormUrlencoded
Sections
Examples
Options
Nested Maps
Summary
Functions
decode/2
encode/2
.Fuse
Sections
Examples
Options
SASL logger
.Headers
Sections
Examples
.JSON
Sections
Examples
Options
Summary
Functions
decode/2
encode/2
.KeepRequest
Sections
Examples
Observability
.Logger
Sections
Examples
Options
Custom log format
Custom log levels
Logger Debug output
Summary
Types
log_level/0
Functions
default_log_level/1
.MessagePack
Sections
Examples
Options
Summary
Functions
decode/2
encode/2
.MethodOverride
Sections
Examples
Options
.Opts
Sections
Examples
.PathParams
Sections
Parameter Values
Parameter Name Restrictions
Examples
.Query
Sections
Examples
.Retry
Sections
Backoff algorithm
Examples
Options
Summary
Functions
retry_after_with_jitter/3
.SSE
Sections
Examples
Options
Summary
Functions
decode/2
.Telemetry
Sections
Examples
Options
Telemetry Events
Legacy Telemetry Events
URL event scoping with Tesla.Middleware.PathParams and Tesla.Middleware.KeepRequest
.Timeout
Sections
Examples
Options
Exceptions
Tesla.Error
Summary
Functions
message/1
Tesla.Mock.Error
Summary
Functions
message/1
Search documentation of tesla
Settings
View Source
Tesla.Middleware.CompressRequest
(tesla v1.14.1)
Only compress request.
See
Tesla.Middleware.Compression
for options.
×