springframework:springdoc

차이

문서의 선택한 두 판 사이의 차이를 보여줍니다.

차이 보기로 링크

--- springframework:springdoc [2020/07/13 17:30]
kwon37xi
+++ springframework:springdoc [2022/06/02 21:49] (현재)
kwon37xi
@@ 줄 2: / 줄 2: @@
   * [[https://springdoc.org/|springdoc-openapi | Library for OpenAPI 3 with spring-boot]]
   * [[:springframework|Spring Framework]] & [[programming:documentation:openapi_spec|Open API Specification]]
+  * OpenAPI 3 어노테이션 없이, Spring MVC/WebFlux 어노테이션을 인식하여 자동으로 OpenAPI Spec 3 문서 생성
+  * [[springframework:springfox|SpringFox]]
-===== 주의 =====
+===== 기본 설정 =====
   * ''@ControllerAdvice'' 사용시 ''@ResponseStatus'' HTTP 응답 코드를 명시할 것.
+  * Spring Properties 설정
+<code yml>
+springdoc:
+  swagger-ui:
+    path: /swagger-ui.html
+  paths-to-match: /api/**
+</code>
+===== springdoc-openapi-gradle-plugin =====
+  * [[https://github.com/springdoc/springdoc-openapi-gradle-plugin|springdoc-openapi-gradle-plugin]]
+  * [[https://github.com/springdoc/springdoc-openapi-maven-plugin|springdoc-openapi-maven-plugin]]
+  * ''swagger.json'' 파일을 생성해준다.
 ===== 참조 =====
   * [[https://www.baeldung.com/spring-rest-docs-vs-openapi|Spring REST Docs vs OpenAPI | Baeldung]]
+  * [[https://www.baeldung.com/swagger-ui-turn-off-in-production|How to Turn Off Swagger-ui in Production | Baeldung]]
+  * [[https://prezi.com/view/r4DP4TCmYUJk1eaqjKG4/|springdoc-openapi intro-v1 by BADR NASS LAHSEN on Prezi Next]]
+  * [[https://www.baeldung.com/spring-rest-openapi-documentation|Documenting a Spring REST API Using OpenAPI 3.0 | Baeldung]]
+  * [[https://dzone.com/articles/openapi-3-documentation-with-spring-boot|OpenAPI 3 Documentation With Spring Boot - DZone Java]]
+  * [[https://dzone.com/articles/doing-more-with-springdoc-openapi|Doing More With Springdoc-OpenAPI - DZone Java]]
+  * [[https://piotrminkowski.com/2020/02/20/microservices-api-documentation-with-springdoc-openapi/|Microservices API Documentation with Springdoc OpenAPI - Piotr's TechBlog]]
+  * [[https://www.youtube.com/watch?v=utRxyPfFlDw|Bringing together OpenAPI 3 and Spring Boot by Badr Nasslahsen @ Spring I/O Bridge - YouTube]]

springframework/springdoc.1594629046.txt.gz · 마지막으로 수정됨: 2020/07/13 17:30 저자 kwon37xi