Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add cURL instructions #8

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/04-concepts/01-working-with-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,16 @@ You can also pass `List` and `Map` as parameters, but they need to be stricly ty

## Return types
The return type must be a typed Future. Supported return types are the same as for parameters.

## Use cURL
You can call your endpoints using cURL or other API platforms (such as _Postman_) using this command:

```console
curl --request GET \
--url http://localhost:8080/example \
--header 'Content-Type: application/json' \
--data '{
"method": "hello",
"name": "World"
}'
```
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,16 @@ You can also pass `List` and `Map` as parameters, but they need to be stricly ty

## Return types
The return type must be a typed Future. Supported return types are the same as for parameters.

## Use cURL
You can call your endpoints using cURL or other API platforms (such as _Postman_) using this command:

```console
curl --request GET \
--url http://localhost:8080/example \
--header 'Content-Type: application/json' \
--data '{
"method": "hello",
"name": "World"
}'
```