69 lines
2.2 KiB
Markdown
69 lines
2.2 KiB
Markdown
|
<!-- Indent Space 3 -->
|
||
|
|
[Go to Index](/README.md)
|
||
|
|
|
||
|
|
# Title
|
||
|
|
|
||
|
|
- ## Function
|
||
|
|
- ### Function Detail(Method)
|
||
|
|
API 설명
|
||
|
|
- Method: ![badge_method_get]
|
||
|
|
```
|
||
|
|
GET /api/v1/template
|
||
|
|
```
|
||
|
|
- Path Parameters:
|
||
|
|
**파라미터명** `REQUIRED`
|
||
|
|
*데이터 타입*
|
||
|
|
파라미터 설명
|
||
|
|
- Body Parameters:
|
||
|
|
**파라미터명**
|
||
|
|
*데이터 타입*
|
||
|
|
파라미터 설명
|
||
|
|
- Example
|
||
|
|
```
|
||
|
|
curl --request GET --url 'http://localhost/api/v1/template
|
||
|
|
```
|
||
|
|
- Results
|
||
|
|
- ![badge_206_ctn]
|
||
|
|
> 결과 설명
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"message": "Ok",
|
||
|
|
"members": [
|
||
|
|
{
|
||
|
|
"name": "john",
|
||
|
|
"age": "18"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "mike",
|
||
|
|
"age": "19"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
```
|
||
|
|
- ![badge_400_invalid]
|
||
|
|
> 결과 설명
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"error": "not found member"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
<!-- Badge Start -->
|
||
|
|
[badge_method_get]: https://img.shields.io/badge/GET-green "GET"
|
||
|
|
[badge_method_post]: https://img.shields.io/badge/POST-ff7f00 "POST"
|
||
|
|
[badge_method_delete]: https://img.shields.io/badge/DELETE-af2020 "DELETE"
|
||
|
|
[badge_method_put]: https://img.shields.io/badge/PUT-af7fdd "PUT"
|
||
|
|
|
||
|
|
[badge_200_ok]: https://img.shields.io/badge/200-green "200 OK"
|
||
|
|
[badge_201_created]: https://img.shields.io/badge/201-green "201 Created"
|
||
|
|
[badge_202_accepted]: https://img.shields.io/badge/202-green "202 Accepted"
|
||
|
|
[badge_204_no_ctn]: https://img.shields.io/badge/204-green "204 No Content"
|
||
|
|
[badge_206_ctn]: https://img.shields.io/badge/206-green "206 Content"
|
||
|
|
[badge_400_invalid]: https://img.shields.io/badge/400-red "400 Invalid Request"
|
||
|
|
[badge_401_unauth]: https://img.shields.io/badge/401-red "401 Unauthorized"
|
||
|
|
[badge_403_fbd]: https://img.shields.io/badge/403-red "403 Forbidden"
|
||
|
|
[badge_404_not_found]: https://img.shields.io/badge/404-red "404 Not Found"
|
||
|
|
[badge_408_timeout]: https://img.shields.io/badge/408-red "404 Request Timeout"
|
||
|
|
<!-- Badge End -->
|
||
|
|
|