Skip to content

Commit

Permalink
RestDocs로 API 문서화하기(오타수정)
Browse files Browse the repository at this point in the history
  • Loading branch information
Choi-JJunho committed Aug 10, 2023
1 parent 5731782 commit 3a98641
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions contents/posts/restdocs-start/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ API 문서화 방식에 대해 찾아본 결과 크게 두가지 방법을 알

### 알아보기

1. Spring RestDocs
`1. Spring RestDocs`

Spring Rest Docs는 Spring에서 제공하는 문서화 도구다.

- 테스트 작성이 강제된다는 특징이 있다.
- 테스트를 통해 도출된 결과를 문서로 작성하기 프로덕션 코드에 영향이 없다는 특징이 있다.
- 아래 설명할 Swagger와 비교했을 때 설정이 약간 번거롭다는 단점이 있다.

2. Swagger
`2. Swagger`

Swagger는 API 문서화를 돕는 오픈소스 툴이다.

Expand Down

0 comments on commit 3a98641

Please sign in to comment.