# Swagger

62개의 포스트
post-thumbnail

Nest JS Swagger

Swagger는 API 문서 자동화 도구이다. 이전에는 API 문서를 따로 작성하여 프런트엔드에게 전달했지만 Swagger를 사용하면 문서 작업 없이 코드를 수정하면서 API 문서를 같이 수정할 수 있다. 코드가 수정되었을 때 API 문서 최신화를 굳이 하지 않아도 되

6일 전
·
0개의 댓글
post-thumbnail

NestJS 13 | Swagger API Documentation

Project 규모가 커질수록 Endpoint와 REST API 수가 많아지며, API 문서화가 제대로 되지 않는다면 협업에 문제가 발생할 여지가 많습니다. 이번 시간에는 NestJS가 제공하는 Swagger Documentation Generator를 이용하여 API

2021년 9월 20일
·
0개의 댓글

[Swagger] Components Section (OpenAPI 3.0)

최근 기존 프로젝트에서 추가된 요구사항을 위해 API와 Web 을 수정하는 작업을 하고 있다. 스웨거를 이용하여 API를 명세하는 것은 처음이여서 기존 코드를 이해하는 데 집중하고 있다. 🙂 그러던 중 `Components Section` 라는 개념을 발견하여 정리

2021년 9월 7일
·
0개의 댓글
post-thumbnail

[Swagger] swagger를 간단하게 사용해보기

Rest API 개발 문서 자동화의 필요성을 느끼게 되었고, swagger을 사용해보기로 하였다. 간단한 로그인과 권한이 필요한 URI 정도로 프로젝트를 구성하여 swagger를 적용해보자.

2021년 9월 6일
·
0개의 댓글
post-thumbnail

Spring Boot에서 Swagger UI 접속이 안되는 경우

스프링 부트에서 Swagger2의 3.0.0 버전을 의존성에 추가했는데, /v2/api-docs는 접근이 되는데 /swagger-ui는 접근이 안됨.아마도 dependencies를 잘못 설정했을 확률이 높다.Gradle 기준, build.gradle에서 다음과 같이 설

2021년 9월 5일
·
0개의 댓글
post-thumbnail

MSA 학습(5) - Swagger로 API 문서 자동화

1. build.gradle 추가 2. config 패키지에 SwaggerConfig 작성 3. 컨트롤러에 ApiOperation 어노테이션 추가 4. 필드에 @ApiModelProperty로 예제 설명 5. http://아이피:포트/swagger-ui.html

2021년 8월 27일
·
0개의 댓글

Spring에 Swagger 적용하기

Spring에서 Swagger를 적용하고 싶어요!

2021년 8월 23일
·
0개의 댓글
post-thumbnail

springdoc으로 swagger적용

API 명세를 간단하게 할 수 있는 swagger를 springdoc을 이용해 사용.RestAPI 서버가 어떤 request가 필요하고 결과가 어떻게 나오는지 문서작업이 필요하다.하지만 일일히 만들기는 번거롭다.Swagger로는 api spec 문서를 자동화해줄 뿐만

2021년 8월 8일
·
0개의 댓글
post-thumbnail

개발 환경 세팅 중 SWAGGER을 만나보았다(스웩넘처서 스웨거 아님)

이번에는 post맨을 사용하는 것이 아니라 swagger을 사용해 api 문서 자동화까지 해볼 예정이다일단 maven에 dependency를 추가해줬다(springfox-swagger-ui는 대시보드 사용을 위해서 추가하는 듯 하다)모지 인텔리제이 문제인감얘는 갑자기

2021년 8월 4일
·
0개의 댓글

swagger-autogen을 이용한 내 프로젝트에 swagger 자동 적용

패키지 설치app.js 수정swagger.js 파일을 root 디렉토리에 추가endpointsFiles에 라우터의 js들을 모두 추가해준다.명령어 실행서버 시작 후 접속내용에 맞게 상세 정보 수정하기autogen으로 들어가지 않는 부분들 (parameter type 등

2021년 8월 2일
·
0개의 댓글

[Project] YAML

Swagger는 YAML 형식을 사용해 설정을 한다. YAML은 이름대로 마크업 언어가 아니고, 주로 설정을 위해 사용한다고 한다. 설정 파일을 위한 목적으로 JSON과 비슷하게 느껴지지만 만들어진 목적과 활용도에 차이가 있다.이 블로그는 내가 YAML과 JSON의 차

2021년 7월 28일
·
0개의 댓글

[Project] Swagger

프로젝트를 시작하기 전에 우선 설계부터 하고 넘어가기로 했다. DB와 기능이 어느정도 나와 있으니, API문서를 Swagger를 이용해 작성해 보도록 한다.OpenAPI 3.0 사용Swagger 사이트Swagger는 YAML 형식을 사용해 설정을 한다. YAML은 이름

2021년 7월 28일
·
0개의 댓글

Spring boot에 Swagger 적용하기(Maven)

스웨거는 Web API 문서화를 위한 도구이다. 일반적으로 프로그램을 개발할 때, 백엔드 개발자와 프론트엔드 개발자가 서로 협력하는 형태로 개발을 진행하게 된다.이 때, 클라이언트 - 서버 사이에서 어떠한 방식으로 데이터를 주고 받을지에 대한 명세가 필요할 수 있다.

2021년 7월 27일
·
0개의 댓글
post-thumbnail

[Node.js] Swagger 개요 + 적용

API 명세를 도와주는 도구

2021년 7월 22일
·
0개의 댓글
post-thumbnail

[TIL] NestJS 공부 38일차

Swagger

2021년 7월 18일
·
0개의 댓글
post-thumbnail

Swagger CORS 오류 해결

이번에 미니프로젝트를 진행하며 추가했던 Swagger에서 CORS 오류가 발생하였다.보통 CORS는 서버와 클라이언트의 origin 이 다를 때 발생하는 문제지만Swagger 같은 경우는 동일한 서버에서 내보냈기 때문에 이런 오류가 발생할 이유가 없었다.원인은 Swag

2021년 7월 14일
·
0개의 댓글

API 문서 웹에 만들기

실무에서 API를 만들다가 엑셀로 API문서를 정리하는게 귀찮았으며 로컬에서 바로 확인 할 수 있게 만들기 위해 Swagger 를 사용해 보았다.request를 주면 response 받는 형식을 알아보기 쉽게 만들어져 있어서 만족하며 사용했다.xml 의존성 추가grad

2021년 7월 8일
·
0개의 댓글

[Error] Swagger 2.9.2 /swagger-ui.html 열리지 않을때 해결

pom.xml에 Spring Swagger 2.9.2 관련 Dependency를 추가하고,SwaggerConfig 관련 Class를 생성하여 Server 실행 시 정상 동작하지만,localhost/swagger-ui.html 로 Swagger 문서 접속이 안되는 상황이

2021년 7월 7일
·
0개의 댓글
post-thumbnail

drf-yasg(swagger)

swagger의 존재를 알고 있었지만 지금까지는 API를 많이 만들어내지 않아서 API 문서 자동화의 필요성을 크게 느끼지 못했다.하지만 최근들어 API를 계속해서 만듦으로써 자동화가 필요하여 swagger를 공부하였다.django-rest-swagger는 오류가 많이

2021년 7월 5일
·
0개의 댓글