본문 바로가기
728x90
반응형
SMALL

swagger4

Spring Rest Docs 이전 포스팅 중 Swagger를 이용한 API 문서화 및 테스트 자동화 (https://kimyhcj.tistory.com/354) 내용이 있다. ​사실 Swagger는 테스트 용이성이 매우 높고 쉽고 빠르게 초기에 진입할 수 있기 때문에 선택했었다. Swagger를 사용해서 API를 모두 만들고 난 후 API에 대해서 FrontEnd 개발자와 이야기해야 할 때 문서가 필요했는데 Swagger 화면으로 설명하기에는 부족함이 많았다. Swagger의 Annotation 설명과 실제 구현코드가 맞지 않을 수 있다는 것. 즉, 문서화 로직이 불일치 할 수 있다는 것이 가장 큰 문제였다. 그리고 소스코드에 더덕더덕 붙어 있는 지저분한 Swagger Annotation들... @ApiOperation(value .. 2020. 5. 22.
Swagger + JWT 2019/08/28 - [IT/Web] - Swagger 를 이용한 API 문서화 및 테스트 자동화(?) Swagger 를 이용한 API 문서화 및 테스트 자동화(?) 요즘 Backend 는 Business Logic 만 수행하고 그에 대한 결과만 반환하며 나머지는 Frontend 에서 처리하도록 구현한다. Backend를 REST API 로 만들게 되면 당연히 그에 대한 API 문서도 필요하게 된다. 그리고 R.. kimyhcj.tistory.com Swagger 를 이용하여 API 문서화와 각각의 API 테스트를 진행하고 있다. 그리고 Restful API 에 대한 인증에 JWT 적용했다. 2019/08/23 - [IT] - JWT (토큰 기반 인증 방식) 의 이해 JWT (토큰 기반 인증 방식) 의.. 2019. 9. 27.
Swagger - java.lang.NumberFormatException: For input string: "" 2019/08/28 - [IT/Web] - Swagger 를 이용한 API 문서화 및 테스트 자동화(?) Swagger 를 이용한 API 문서화 및 테스트 자동화(?) 요즘 Backend 는 Business Logic 만 수행하고 그에 대한 결과만 반환하며 나머지는 Frontend 에서 처리하도록 구현한다. Backend를 REST API 로 만들게 되면 당연히 그에 대한 API 문서도 필요하게 된다. 그리고 R.. kimyhcj.tistory.com 를 사용해서 API 문서를 자동화 하고 테스트도 편하게 하고 있다. 그런데 Swagger-UI 에 접속 시 알 수 없는 예외 메시지가 발생한다. java.lang.NumberFormatException: For input string: "" swagger2.. 2019. 9. 20.
Swagger 를 이용한 API 문서화 및 테스트 자동화(?) 요즘 Backend 는 Business Logic 만 수행하고 그에 대한 결과만 반환하며 나머지는 Frontend 에서 처리하도록 구현한다. Backend를 REST API 로 만들게 되면 당연히 그에 대한 API 문서도 필요하게 된다. 그리고 REST API를 테스트 하기 위해서는 다양한 테스트 도구들을 이용할 수 있다. curl을 이용하여 간단하게 command 에서 테스트해 볼 수도 있고 나는 주로 chrome 확장 application 인 ARC 를 이용했었다. 결론적으로 API 서버는 'API문서' 와 '테스트도구' 가 필요하다. Swagger 는 이 두가지 요구사항을 만족시키는 좋은 방안중 하나이다. 현재 개발진행중인 프로젝트에 Swagger를 적용시켜 보자. pom.xml 에 dependen.. 2019. 8. 28.
728x90
반응형
LIST