API endpoint doc
Documents one endpoint.
- Note
- Engineering docs
- 3 blanks to fill
API: Path ## GET Path Description ### Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | | | | | ### Response ```json {} ```
Orange words are blanks you have not filled yet. Press ⌘ Return to copy.
About this template
Documents one endpoint.
- Category
- Software development
- Pack
- Engineering docs
- Type
- Note, a longer document
- Asks for
- Path, Method, Description
Use it anywhere you write: email, chat, a document or a support tool. If you send it often, save the finished text as a snippet in ClipBuddy and paste it again from your clipboard history with ⌘⇧V.
Template source
The template as written, with its blanks in double braces, such as {{Name}}.
API: {{Path}}
## {{choice:Method|GET|POST|PUT|PATCH|DELETE}} {{Path}}
{{Description}}
### Parameters
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| {{cursor}} | | | |
### Response
```json
{}
```