Method in REST API, also known as HTTP verbs, define the actions that clients can perform on resources. They’re the fundamental commands that drive the interaction between a client application (e.g., your web browser or a mobile app) and the server hosting the API. Mastering these methods is essential for effectively using and building RESTful web services.
Why HTTP Method in REST APIs are Crucial?
Each HTTP method has a distinct purpose, mapping to common operations you’d perform on data in any application. By adhering to these standardized methods, REST APIs ensure a consistent and predictable way for clients to interact with resources, making them easier to understand and integrate.
5 Essential Method in REST API
- GET: The Retriever
- Purpose: Retrieve a representation of a resource.
- Use Cases: Fetching a list of items, retrieving a single item by its ID, or querying data based on specific parameters.
- Example:
GET /api/products
(Fetch all products)
- POST: The Creator
- Purpose: Create a new resource or submit data.
- Use Cases: Adding a new user, submitting a form, or initiating a process on the server.
- Example:
POST /api/orders
(Place a new order)
- PUT: The Replacer
- Purpose: Update or replace an existing resource entirely.
- Use Cases: Modifying all details of a user profile or replacing the content of a document.
- Example:
PUT /api/users/123
(Update all details of user with ID 123)
- PATCH: The Modifier
- Purpose: Partially update an existing resource.
- Use Cases: Changing a single field in a user profile or updating a specific attribute of a product.
- Example:
PATCH /api/products/456
(Change the price of a product with ID 456)
- DELETE: The Remover
- Purpose: Remove a resource.
- Use Cases: Deleting a user account, canceling an order, or removing an item from a list.
- Example:
DELETE /api/comments/987
(Delete a comment with ID 987)
REST API Methods: Additional Considerations
- Idempotence: Some methods (GET, PUT, DELETE) are idempotent, meaning multiple identical requests have the same effect as one. POST and PATCH are not idempotent.
- Safety: GET requests are considered safe as they don’t modify resources.
- Custom Methods: While the five listed methods are the most common, REST allows for custom methods in specific scenarios.
FAQs: Method in REST API
Q: How do I know which method to use for a specific action?
A: Follow RESTful conventions: use GET for retrieving data, POST for creating new resources, PUT for full updates, PATCH for partial updates, and DELETE for removing resources.
Q: Can I use the same endpoint for different methods?
A: Yes! RESTful APIs often use the same endpoint with different HTTP methods to perform various actions on the same resource.
Q: What if my API doesn’t support a specific method?
A: The server should respond with a 405 Method Not Allowed
status code, indicating the method is not supported for that resource.