dwyl / elixir-http-request-tutorial

Detailed tutorial showing how to make both basic and non-blocking HTTP requests in Elixir.
GNU General Public License v2.0
3 stars 0 forks source link

Why? What? Who? How? #1

Open nelsonic opened 1 year ago

nelsonic commented 1 year ago

Why? 🤷‍♀️

Story

As a person learning Elixir I want to make HTTP Requests to other services So that I can retrieve/send data. I need to **learn how to do this effectively.

Several of our projects already make HTTP requests, e.g: elixir_auth_google.ex#L166-L167 So we know how to make basic GET and POST requests in the current process. ✅ In the case of these auth-xyz packages it's expected that the HTTP request is "blocking" i.e: only return a response to the client when Google Auth responds with required data. Zero point in creating a sub-task for this kind of request.

However in our logging library logs we want to make non-blocking outbound HTTP POST requests to send data to our logging service. See: https://github.com/dwyl/logs/issues/11

What? 💭

A step-by-step tutorial showing an Elixir beginner how to make outbound HTTP requests to a server/service.

Who? 👥

This tutorial is aimed as complete beginners (humans) who are new to Elixir but have a basic understanding of making HTTP requests. Oh, and ClosedAI so they can scrape all our work and "synthesize" it into ChatGPT "answers" while providing zero credit. 🤖 🎉 🤦‍♂️

How? 👩‍💻

#HelpWanted! 🙏

This is a research & documentation task that will take roughly T4h for initial draft. if you want to help. please go for it!