# Swagger

junsj119

스코프가 줄은 만큼 백에서 할 수 있는 것을 찾고있다. 프론트 분이 고생이 많으신데 페이스 조절을 잘 하셨으면 좋겠다. swagger란? Swagger란 개발한 REST API를 편리하게 문서화 해주고, 이를 통해서 편리하게 API를 호출해보고 테스트할 수 있는 프로젝트이다. SpringBoot 프로젝트의 문서화를 위해 Swagger를 적용한다. 적용 ...

top7578

프로젝트를 진행하며 API 문서화 과정은 필요하다. 클라이언트 측에서 개발을 진행하며 해당 문서를 참고하여 팀의 생산성을 높여줄 수 있고, 나중에 해당 프로젝트를 다시 접하게 될 경우 상당 부분 잊어버릴 것이기 때문에 문서로 남겨둔다면 이를 활용하여 도움을 받을 수 있

eeeve

오늘의 목표 1. 데이터 전송 방법 1-1 HTTP 1-2 API 1-3 GraphQl vs Rest 1-4 JSON 1-5 CRUD 2. 데이터 전송 실습 2-1 Postman 2-2 Playground

zoshs2000

개인 프로젝트 시작에 앞서 방향성을 정의하고자 한다. 포인트는 4가지(사용언어, 주제, 형상관리 플랫폼, 문서화) NodeJS 가장 관심이 가는 언어이다. 학습의 접근성도 쉬울뿐더러 여러 GitLab VS GitHub GitLab과 GitHub는 모두 Git을 이용

duddnd904

단점 FrontEnd는 문서를 보고 이해하는 일Backend는 문서를 만드는 일문서를 수정해야하는 일이 생길 때Swagger 기존 문서로 사용하던 문제를 해결하기 위해 Swagger 사용간단한 설정으로 프로젝트의 API 목록을 웹에서 확인 및 테스트 할 수 있게 해주는

shawnhansh

Swagger를 처음 사용해보며 마주친 오류입니다.분명히 Swagger 설정도 잘 했고, 관련 어노테이션도 맞게 잘 적었는데 자꾸 JoinRequestDto가 포함된 API를 오픈할 때면 위와 같은 오류가 발생했어요.응답 부분에서도 example 부분이 아예 표시되지

nche

The supported-submit-methods array contains 'get', 'post', 'patch', 'put', 'delete', 'options'.But if you leave an empty array, you can't try-out API,

cokkum113

swagger설정중에 갑자기 에러가 발생을 했다. 이 부분은 제일 아래 부분에서 다룰 것이다. 먼저 스웨거의 의존성부터 해보자!개발을 하다보면 api를 정리해야한다. 이를 자동화해주는 문서가 swagge이다. swagger설정에대해 알아보자. build.gradleSw

nuri00

저번 시간

mageboy

프로젝트에서 기존 gitbook으로 작성한 API는 API 확인을 위해 사이트에 들어가서 확인해야 하는 불편함때문에 대체 방안을 고민하게 되었고swagger API는 서버를 틀어 특정 엔드포인트에 들어가면 API를 바로 볼 수 있다는 정보 떄문에 바꾸게 되었다API를

kimja01

swagger 란 공식문서에 다음과 같이 정의되어 있습니다REST API를 설계, 빌드, 문서화 및 사용하는 데 도움이되는 OpenAPI 사양을 중심으로 구축 된 오픈 소스 도구 세트입니다.간단히 말하자면 API 문서 자동화 도구이며, API를 테스트할 수 있는 화면을

siontama

지금까지 어떤 방식으로 구현이 가능할지 점검을 했으니 이제 본격적인 개발에 착수했다front-end와 back-end팀을 나누어 작업을 진행하고 각각 React와 Spring을 사용하여 개발하기로 했다해당 프레임워크를 선정한 이유는 학습의 목적이기 때문에 특별히 특성을

___pepper

Nest.js에서 swagger document 작성해보기

robinkim93

회원가입 api를 적용하던 중 사용하게 된 모듈 두개를 소개한다.먼저 bcrypt는 클라이언트 및 프론트엔드단에 유포되면 안되는 password 등 같은 정보를 hash(암호화)처리 해준다. $ npm i bcrypt$ npm i -D @types/bcrypt먼저 np

ghc1124

프론트 개발자와 백 개발자 사이 개발 상황 변화에 따른 API의 변동 사항 발생 시 이때마다 문서를 수행하는 번거로움이 발생 → 이를 해결하기 위해 Swagger 사용간단한 설정으로 프로젝트의 API 목록을 웹에서 확인 및 테스트 할 수 있게 해주는 라이브러리Swagg

mraz0210

Spring의 경우 Application을 개발하려면 사전에 많은 작업을 해야 했다.SpringBoot의 장점Project에 따라 자주 사용되는 Library들이 미리 조합되어 있다.복잡한 설정을 자동으로 처리.내장 서버를 포함해서 Tomcat과 같은 WAS를 추가로

pjm2207

Nest.js Swagger 설정방법

nuri00

본인은 swagger 모듈을 따로 설치하지 않고 swagger viewer라는 확장 프로그램을 사용했습니다.vsCode 설정에 들어가서 swagger viewer를 치면 나오는 Preview In Browser를 체크해준다.체크하지 않으면 vsCode 프로그램 내에서

monkeydugi

모든 기술이 그렇겠지만 이 역시 장전점이 있는 부분이라서나는 스웨거를 추구했지만 팀원들이 Rest Docs를 사용하자고 해서선택하게 되었다. 장단점을 알아보자.우리 프로젝트는 문서화 도구로 Markdown이 아닌 AsciiDoc을 사용했다.ATDD 교육 과정에서 사용

wngud4950

2번의 프로젝트 동안 Gitbook을 사용해서 API 명세들을 관리했다. 처음부터 Gitbook을 써와서 다른 걸 써볼 생각은 안했는데 프로젝트를 진행하면서 느낀 불편한 점들이 있어 대체재들이 있는 지 찾아봤다. 그러다가 Swagger API가 자동화와 테스트를 지원해