[Web best practices] Some cool things I note when I'm learning on Internet

web-best-practices.md

Best practice for RESTful API design

Parameters

• Path Params: identify a specific resource of resources
• Query Params: soft/filter resources

Example: RESTful API endpoints for an entity called Car

Path params

• GET /cars
• GET /cars/:id
• POST /cars
• PUT /cars/:id
• DELETE /cars/:id

Query params: filter the cars by color

color is not a resource (a property of a resource)
delimiter & for more property

• GET /cars?color=blue
• GET /cars?color=blue&brand=ferrari

Naming

• All lowercases
• Hyphen separate words

Use correct HTTP status code

• 200 for GET, PUT, POST, DELETE, ...
• 201 specifically for POST, PUT
• 204 for any methods, headers useful

Python naming

• File: underscore
• Method: underscore

fetch() vs axios(): https://blog.logrocket.com/axios-vs-fetch-best-http-requests/

• Basic syntax
• Backward compatibility
• Response timeout
• Auto JSON data transform
• HTTP interceptor (change HTTP req from app to server, from server to app (e.g. logging, auth, retry failed HTTP req))
• Download progress
• Simultaneous reqs