How to Design a REST API That Doesn’t SUCK| Issue #10


Hi there,

Want to improve your REST API design? Then this week’s video is for you! 🌟

I’ll share 6 easy tips for creating user-friendly, consistent, and easily integrated REST APIs.

We’ll dive into often-overlooked aspects of REST API design, including:

  • Following standards like OpenAPI specs and OAuth for authentication 🛠️
  • Ensuring consistency in formats and naming conventions 📏
  • Keeping things simple with sensible defaults, and much more! ✨

Even big companies sometimes miss these crucial details, making their APIs harder to use. 😅

Stick around until the end for BONUS tips! 🎁

Enjoy the video and happy coding! 🚀

Cheers,

Arjan

video preview

# News

Secure Python Projects

This week, learn how to securely manage configurations and sensitive information using environment variables and dotfiles.

Protect your API keys, manage database connections, and centralize configurations effortlessly. Click here to read the blog and enhance your workflow. 🔗

Understanding Code Coverage 🧑‍💻

Marcus Buffett recently published an insightful blog post exploring the nuanced role of abstractions in programming. 🖥️

He breaks down how abstractions can make code safer and more flexible, but also warns about potential downsides like fragility and complexity.

This article is a must-read for developers looking to master the balance between abstraction and practical coding. Click here to find out more. 🛠️

# Community

Curious about the pros and cons of type hinting and static typing? 💭

Our community recently had an engaging discussion on this topic, exploring insights from industry experts and sharing personal experiences. The conversation covers how type hints can improve code clarity, support from IDEs, and reduce the need for extensive documentation. There’s also a lively debate on whether type annotations adhere to the DRY (Don’t Repeat Yourself) principle or add unnecessary redundancy.

Dive into the full discussion and enhance your understanding of type hinting! Read the full thread here. 📚


Do you enjoy my content on YouTube and would you like to dive in deeper? Check out my online courses below. They've helped thousands of developers take the next step in their careers.

🚀 The Mindset Online Course Series

The goal of this series is to help junior developers grow their skills to become senior developers faster.

💥 Other Courses

💡 If you’re part of a development team at a company, I offer special packages for companies that give your team the tools to consistently write high-quality code and dramatically increase your team's productivity.

🪄 Learntail

My team and I created an AI quiz generator designed to accelerate your learning, called Learntail. You can try it for free or unlock even more capabilities and features with the monthly subscription. Take a look here.

Unsubscribe | Send by ArjanCodes

Wolvenplein 25, Utrecht, UT 3512 CK

The Friday Loop

Every Friday, you'll get a recap of the most important and exciting Python and coding news. The Friday Loop also keeps everyone posted on new ArjanCodes courses and any limited offers coming up.

Read more from The Friday Loop

Hi there, Have you ever found yourself writing functions like this? def render_article(article_id, db, logger, user, config, feature_flags, etc): …and then passing the same parameters through five different layers of your app? In my latest video, I walk through a realistic Python example and show how to fix this mess using the Context Object Pattern. I’ll start with the "before" version, refactor step by step, and explore: How to group related dependencies using a context object When this...

Hi there, This week’s video is all about uv workspaces, and why they’ve completely changed the way I manage Python projects. In the video, I walk you through a real-world example: I build a CLI tool and a FastAPI API that both fetch and summarize news headlines using OpenAI. But the real lesson is in how the project is structured. I show you how to share a local package between apps, define common dependencies like openai or httpx only once. And you can manage everything using uv’s workspace...

Hi there, When I see an if-statement with multiple elifs in my code, it almost always triggers an investigation. Is there some way to rewrite this to make the logic simpler? Is there a chance that in the future I'll need to add even more complexity? If so, I'll try to redesign the code so that I don't need that chain of if-elif statements. In this week’s video, I cover a design pattern that helped me eliminate many of those chains from a project + at the same time made the code easier to...