Notice
Recent Posts
Recent Comments
Link
일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | 7 |
8 | 9 | 10 | 11 | 12 | 13 | 14 |
15 | 16 | 17 | 18 | 19 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 | 30 | 31 |
Tags
- springboot
- broker
- API문서
- tsdb
- Zookeeper
- JDK
- VictoriaMetrics
- OFFSET
- ProjectLoom
- java
- spring
- webflux
- Reassign
- Mirror
- raft
- 비동기
- swagger
- Brooklin
- ExecutableJar
- JVM
- Vmalert
- Reactive
- NoClassDefFoundError
- kafka
- Rebalance
- consumer
- OpenJDK
- Vmagent
- restdocs
Archives
- Today
- Total
목록 API문서 (1)
거북이 developer
💡 Spring Rest Docs 로 Swagger API 문서 관리 자동화
💬 Spring Rest Docs 란? Spring REST Docs 는 RESTful 서비스의 문서화를 도와주는 도구이다. 문서 작성 도구로 Asciidoctor 를 기본적으로 사용하며, 이것을 통해 HTML 문서를 생성한다. 필요한 경우 Markdown 문법을 사용하도록 변경할 수 있다. RESTful API를 문서화 할때 중요한 포인트는 API 에서 필요한 HTTP 요청과 응답의 리소스를 설명하는 것인데 Spring REST Docs 를 사용할 경우 테스트 코드를 작성하여 이러한 리소스와 HTTP 요청/응답에 대한 세부 내용을 문서화하는데 편리한 기능을 제공한다. 💬 Swagger 란? RESTful API 를 약속된 규칙에 따라 json 이나 yaml 형식으로 문서화한 Open API Specif..
Spring Framework
2022. 8. 26. 15:31