APIs in Practice : the road to production-ready

In this workshop, we will design APIs with respect to the non-functional requirements that are paramount to any serious application running in production.

This is a hands-on workshop, so be prepared to write code!

We will start by designing an API with all the production-ready quality attributes. Then, we expand the feature set so that, in the end, we have an overview of the steps we have to take to have robust APIs that are reliable and capable of effortlessly managing heavy loads without breaking a sweat.

We delve into the intricacies of REST-based APIs, exploring the client/server nature and the decision-making process behind choosing REST, endpoint naming, and capabilities. This offers a detailed guide to the API design process, documentation, and the most common usage scenarios.

REST Basics

• Http methods
• HTTP status codes
• Http headers
• Endpoint naming
• Media-type selection, design & custom media types
• Documenting APIs
• Versioning techniques
  

Performance, Scalability and Resilience

In this section, we will address some non-functional requirements that should be mandatory for any serious API running in production

• Compression and caching types
• Rate limiting
• Caching & Conditional caching
• Measuring performance

Prerequisite

This is a Bring Your Own Device (BYOD) workshop. Therefore, attendees are required to bring their own device with the necessary software already installed:

• Need to have Visual Studio, or an IDE you are familiar with
• .NET 8 or higher
• Docker
• GitHub
• MSSQL

Who should attend?

• .NET Software developers who want to have a more architecture-focused approach
• C# developers who want to understand the patterns and the best practices

At the end of this workshop you will be able to:

• understand which APIs are best suited for which scenarios
• understand are the non-functional requirements needed for a production-ready APIs