springframework:springfox

차이

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

차이 보기로 링크

--- springframework:springfox [2018/07/24 13:46]
kwon37xi [Spring MVC and swagger]
+++ springframework:springfox [2020/08/26 10:32] (현재)
kwon37xi
@@ 줄 2: / 줄 2: @@
   * https://springfox.github.io/springfox/docs/current/
   * [[programming:documentation:swagger|Swagger]] 의 Spring 구현
+  * Swagger -> OpenAPI Specification 이 되었으며, OpenAPI Specification 문서화는  [[springframework:springdoc|SpringDoc - SpringFramework Open API Specification]] 참조.
@@ 줄 49: / 줄 50: @@
     }
 }
+</code>
+===== 숫자값 parsing 에러 =====
+  * 파라미터 타입이 primitive 숫자(int, long 등)인데, example을 지정하지 않으면 empty string이 example로 들어오게 되고, 그로인해 Swagger UI 출력시 숫자값 파싱 오류가 발생한다. 이때 example을 적합한 숫자로 넣어주면 된다.
+  * 원칙적으로 Boxed Type에 대해서는 발생하지 않을거 같고 일부 괜찮은데 일부는 또 파싱 오류가 발생하기도 한다.(example값에 empty string을 넣어서)
+<code java>
+@ApiParam(value = "userId", defaultValue="1", example = "1") int userId;
 </code>
 ===== 참조 =====
   * [[http://www.baeldung.com/swagger-2-documentation-for-spring-rest-api|Setting Up Swagger 2 with a Spring REST API ]] [[http://springboot.tistory.com/24|Spring REST API에 Swagger 2 설정하기]]
+  * [[https://dzone.com/articles/spring-rest-docs-versus-springfox-swagger-for-api|Spring REST Docs Versus SpringFox Swagger for API Documentation - DZone Java]]
+  * [[https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api|Setting Up Swagger 2 with a Spring REST API | Baeldung]]
+  * [[https://www.baeldung.com/swagger-ui-turn-off-in-production|How to Turn Off Swagger-ui in Production | Baeldung]]

springframework/springfox.1532407579.txt.gz · 마지막으로 수정됨: 2018/07/24 13:46 저자 kwon37xi