From 332159adfdf86bd1c2aec678d7a0a229d847d036 Mon Sep 17 00:00:00 2001 From: Kumar Abhishek Date: Sun, 15 Dec 2024 20:56:02 +0530 Subject: [PATCH] feat: updated example for markdown formatting --- markdown/example.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/markdown/example.md b/markdown/example.md index e69de29..6f0e7a4 100644 --- a/markdown/example.md +++ b/markdown/example.md @@ -0,0 +1,39 @@ +#
APIs + +## APIs (optional) + + +### 1. API + +Write the API short description here. + +#### Details +- **Method:** GET/POST/PUT/DELETE +- **URL Endpoint:** /customer/payment/product/{param1} +- **Request Structure:** + - Path Parameters: + - param1 (string / required) - Description of the parameter to be passed in the URL placeholders + - Query Parameters: + - param2 (string / optional) - Description of the parameter for GET requests + - Body Parameters: + - param3 (string / required) - Description of the parameter for POST/PUT requests + +#### Example Response (200 OK) +```json +{ + "status": 0, + "message": "Success", + "data": { + "param1": "value1", + "param2": "value2", + "param3": "value3" + } +}``` + +#### Description + +Write the API detailed description here. + + +### 2. API +...