Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 958bba8

Browse files
authored
Update README.md
1 parent 15db9eb commit 958bba8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ components:
185185
```
186186

187187
### 4. 결론
188-
REST Docs의 장점과 Swagger의 장점을 갖춘 API 문서화를 구현해봤습니다. 참고로 갓 입사한 동료에게 OAS 파일을 선물하면 Postman, Insomnia 같은 API Client에서 Import하여 사용할 수 있는 장점 또한 있습니다. :) 마지막으로 실제 사용 전에 아래 주의사항을 확인해주세요.
188+
REST Docs의 장점과 Swagger의 장점을 갖춘 API 문서화를 구현해봤습니다. OAS 파일을 Postman, Paw, Insomnia 같은 API Client에서 Import하여 사용할 수 있는 장점 또한 있습니다. 옆자리 동료에게 공유해보세요. :) 마지막으로 실제 사용 전에 아래 주의사항을 확인해주세요.
189189

190190
#### 4.1. 주의사항
191191
* 배포 환경에 따라 바로 사용하기 어렵거나 수정이 필요할 수 있습니다. 제가 다니는 회사의 배포 파이프라인에 맞춰 구성한 예제이므로 참고 부탁드립니다.
@@ -195,4 +195,4 @@ REST Docs의 장점과 Swagger의 장점을 갖춘 API 문서화를 구현해봤
195195
* https://swagger.io/resources/articles/documenting-apis-with-swagger/
196196
* [Swagger UI Installation - Standalone Download](https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/ "")
197197
* [Spring REST Docs 기반 OAS format generator - ePages-de/restdocs-api-spec](https://github.com/ePages-de/restdocs-api-spec "")
198-
* [Swagger와 Spring Restdocs의 우아한 조합 (by OpenAPI Spec) - 꿈꾸는 태태태의 공간](https://taetaetae.github.io/posts/a-combination-of-swagger-and-spring-restdocs/ "")
198+
* [Swagger와 Spring Restdocs의 우아한 조합 (by OpenAPI Spec) - 꿈꾸는 태태태의 공간](https://taetaetae.github.io/posts/a-combination-of-swagger-and-spring-restdocs/ "")

0 commit comments

Comments
 (0)