Markdown Toolbox Logo Markdown Toolbox
বাড়ি
ব্লগ

আমাদের কাছে ইংরেজিতে আরেকটি পৃষ্ঠা আছে। আপনি কি ভাষা পরিবর্তন করতে চাইবেন?

We have another page in English. Would you like to change languages?

হ্যাঁ / Yes না / No

মার্কডাউন এপিআই ডোক্যুমেন্টেশন টেম্পলেট

2023-11-25

এপিআই ডকুমেন্টেশন মার্কডাউন ব্যবহার করে

মার্কডাউন আপনার এপিআই ডকুমেন্ট করার একটি সহজ উপায় প্রদান করে, যা ওয়েব এবং টেক্সট এডিটর উভয়েতেই পাঠযোগ্য। এখানে একটি মৌলিক টেম্পলেট:

# এপিআই নাম

## এন্ডপয়েন্ট: `/example-endpoint`

- **পদ্ধতি:** `GET`
- **বিবরণ:** উদাহরণ ডেটা গ্রহণ করে।  

### অনুরোধ প্যারামিটারসমূহ

- `param1` (অবশ্যক): param1 এর বিবরণ।
- `param2` (বিকল্প): param2 এর বিবরণ।  

### প্রতিক্রিয়া

```json
{
  "data": "Sample data"
}
```

মনে রাখবেন আপনার ডকুমেন্টেশনকে সর্বাঙ্গীণ করতে অটেন্টিকেশন পদ্ধতি, রেট লিমিট এবং প্রতিক্রিয়া কোডের মতো আরও গুরুত্বপূর্ণ তথ্য অন্তর্ভুক্ত করতে।