Markdown API 문서 템플릿

2023-11-25

마크다운을 이용한 API 문서화

마크다운은 API 문서화의 간단한 방법을 제공하여, 웹과 텍스트 편집기에서 모두 읽기 쉽게 만듭니다. 기본 템플릿은 다음과 같습니다:

# API 이름

## 엔드포인트: `/example-endpoint`

- **메서드:** `GET`
- **설명:** 예제 데이터를 검색합니다.

### 요청 매개변수

- `param1` (필수): param1에 대한 설명.
- `param2` (선택 사항): param2에 대한 설명.

### 응답

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


문서가 포괄적으로 되도록 인증 방법, 속도 제한, 응답 코드와 같은 필수 정보를 포함하는 것을 잊지 마십시오.