ਮਾਰਕਡੌਨ ਏਪੀਐਈ ਪ੍ਰਾਧੀਕਾ ਟੈਂਪਲੇਟ

2023-11-25

API ਦਸਤਾਵੇਜ਼ਿਕਤਾ ਮਾਰਕਡਾਊਨ ਦੀ ਵਰਤੋਂ ਕਰਕੇ

ਮਾਰਕਡਾਊਨ ਤੁਹਾਡੇ API ਨੂੰ ਦਸਤਾਵੇਜ਼ਿਤ ਕਰਨ ਦਾ ਇੱਕ ਸਧਾਰਣ ਤਰੀਕਾ ਪ੍ਰਦਾਨ ਕਰਦਾ ਹੈ, ਜਿਸ ਨਾਲ ਇਹ ਵੈੱਬ ਤੇ ਅਤੇ ਪਾਠ ਸੰਪਾਦਕਾਂ ਵਿੱਚ ਪੜ੍ਹਨਯੋਗ ਬਣਦਾ ਹੈ। ਇੱਥੇ ਇੱਕ ਮੂਲ ਟੈਮਪਲੈਟ ਦਿੱਤਾ ਗਿਆ ਹੈ:

# API ਦਾ ਨਾਮ

## ਏਂਡਪੋਇੰਟ: `/example-endpoint`

- **ਤਰੀਕਾ:** `GET`
- **ਵਰਨਨ:** ਉਦਾਹਰਨ ਡੇਟਾ ਪ੍ਰਾਪਤ ਕਰਦਾ ਹੈ।

### ਬੇਨਤੀ ਪੈਰਾਮੀਟਰ

- `param1` (ਲਾਜ਼ਮੀ): param1 ਦਾ ਵਰਣਨ।
- `param2` (ਇੱਛਾਵਾਂ): param2 ਦਾ ਵਰਣਨ।

### ਜਵਾਬ

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


ਯਾਦ ਰਖੋ ਕਿ ਤੁਹਾਡੇ ਦਸਤਾਵੇਜ਼ਿਕਤਾ ਨੂੰ ਵਿਆਪਕ ਬਣਾਉਣ ਲਈ ਲਾਜ਼ਮੀ ਜਾਣਕਾਰੀ ਵਰਗੀ ਕਿ ਪਛਾਣ ਮੈਥਡ, ਦਰ ਦੀਆਂ ਸੀਮਾਵਾਂ ਅਤੇ ਜਵਾਬ ਕੋਡ ਸ਼ਾਮਲ ਕਰੋ।