API Status Codes and OpenAPI Documentation - Backend Engineering


If you've enjoyed any of this material I encourage you to check out my courses. These cover topics comprehensively and are a great way to level up your engineering skills and career. You'll also gain access to the CodeBreakthrough community for networking and accountability.
To get started, check out Software Engineering Fundamentals.
You can use coupon code NOTES to get 15% off.


Standard structure

We talked about the most common HTTP methods and path structures.

As a quick review, we use a plural resource followed by an ID if needed.

PUT /comments/{id}

There are different structures you could pass within the body:

Arrays
Object
Object with a nested object for the data

Let's say we are working with notifications and we have an endpoint PATCH /users/{123}/settings

Locked Content