2023-11-25
Markdown zapewnia prosty sposób dokumentowania API, czyniąc to czytelnym zarówno w sieci, jak i w edytorach tekstowych. Oto podstawowy szablon:
Markdown Toolbox
# Nazwa API
## Punkt końcowy: `/example-endpoint`
- **Metoda:** `GET`
- **Opis:** Pobiera przykładowe dane.
### Parametry żądania
- `param1` (wymagane): Opis parametru param1.
- `param2` (opcjonalne): Opis parametru param2.
### Odpowiedź
```json
{
"data": "Sample data"
}
Pamiętaj, aby uwzględnić istotne informacje, takie jak metody autoryzacji, limity czasowe i kody odpowiedzi, aby uczynić dokumentację kompleksową.