added API methods to the documentation

pull/92/head
Sujan Midatani 2024-05-11 23:02:34 +05:30
rodzic 2e2515bfc9
commit a7c8843967
2 zmienionych plików z 28 dodań i 1 usunięć

Wyświetl plik

@ -0,0 +1,27 @@
## API Methods
- **GET**:
- The GET method is used to retrieve data from a specified resource.
- It is a safe and idempotent method, meaning that it should not have any side effects and can be called multiple times without changing the result.
- Use the GET method when you want to retrieve information from the server.
- **POST**:
- The POST method is used to submit data to be processed to a specified resource.
- It is not idempotent, meaning that calling the same POST request multiple times may result in different outcomes.
- Use the POST method when you want to create a new resource on the server.
- **PUT**:
- The PUT method is used to update a specified resource with new data.
- It is idempotent, meaning that calling the same PUT request multiple times should have the same effect as calling it once.
- Use the PUT method when you want to update an existing resource on the server.
- **PATCH**:
- The PATCH method is used to apply partial modifications to a resource.
- It is not idempotent, meaning that calling the same PATCH request multiple times may result in different outcomes.
- Use the PATCH method when you want to update a resource with partial data.
- **DELETE**:
- The DELETE method is used to delete a specified resource.
- It is idempotent, meaning that calling the same DELETE request multiple times should have the same effect as calling it once.
- Use the DELETE method when you want to remove a resource from the server.

Wyświetl plik

@ -1,3 +1,3 @@
# List of sections
- [Section title](filename.md)
- [API Methods](api-methods.md)