API 설계 문서화

tokkaiiii·2025년 6월 19일

스프링테스트

목록 보기
2/9

1. README 파일 이용

# 제목 - 설명
상세설명
## 부제목
### 부제목 내용 중 하위 제목

2. 들어갈 내용

(1) 제목: 제목

(2) 부제목

  • 빌드
  • 실행
  • API 목록

(3) 부제목 내용 중 하위 제목
대표 예시: API 목록에 대한 제목

### 회원가입
요청
성공응답
정책
테스트

이렇게 크게 적고 차례로 내용 적어 내려가자

### 회원가입
요청
- 메서드: POST
- 경로: /users/signUp
- 헤더
	```
    Content-Type: application/json
    ```
- 본문
	```CreateUserCommand {
    	email: string,
        username: string,
        password: string
    }
    ```
성공 응답
- 상태코드: 204 No Content
정책
-
-
-
테스트
- [ ] 
- [ ]
profile
풀스택 자바 개발자입니다

0개의 댓글