Skip to content

Commit

Permalink
Merge pull request #13 from ekoindia/dev
Browse files Browse the repository at this point in the history
feat: updated example for markdown formatting
  • Loading branch information
manustays authored Dec 15, 2024
2 parents 2561491 + 332159a commit 0ed118f
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions markdown/example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# <Main Category> APIs

## <Sub Category> APIs (optional)


### 1. <API Name> 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 Name> API
...

0 comments on commit 0ed118f

Please sign in to comment.