# Swagger

22개의 포스트

Spring Boot에 Swagger 적용하기

최근에 처음으로 팀으로서 프로젝트를 진행해보았다. 프로젝트 기획 및 프론트엔드 개발 역할로 프로젝트를 진행하였는데, 기획 및 커뮤니케이션 부분에서 많이 부족했고 또 많이 배울 수 있는 시간이었다.디자인을 맡은 팀원과 백엔드 개발을 맡은 팀원과 동시에 커뮤니케이션을 해야

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

Nestjs 프로젝트에 Swagger 도입하기

프로젝트의 사이즈가 커질수록 REST API의 수가 정말 어마 무시하게 많아지는데요, API가 문서화되지 않는다면 어떤 API들이 있었나 헷갈려서 소스코드 이곳저곳을 뒤적거리는 일이 발생할 수 있습니다.그렇다고 따로 문서에 엔드 포인트, 파라미터, 결괏값 등을 적어놓자

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

Django REST Framework에서 API 문서 자동화하기

지금 감사하게도 몇 군데 면접을 보고 있다. 오프라인에서 면접을 바로 본 회사도 있었고, 코딩 테스트를 보내주는 회사도 있고, 그리고 코딩 과제라고 해서 API를 만들어야 되는 회사도 있었다.Django REST Framework를 기반으로 API를 만들어가고 있는데

2021년 2월 21일
·
2개의 댓글
post-thumbnail

✨ nginx swagger-ui

ec2 > nginx > gunicorn > django 를 붙이고 나서 스웨거에 접속을 했는데, ui 가 전혀 없는 상태였습니다. 😂개발자 도구로 확인해보니, not found.... nginx 를 붙이면서, static 파일들을 한 곳으로 모아줬어야 했는데 모아주

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

Swagger-ui 확인 및 기능 테스트

CalculatorService.javaWeb API 클래스 작성2-1. CalculatorResult.java2-2. CalculatorApiController.javaWeb API 실행http://localhost:8080/calculator/api/cal

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

Swagger 개요 및 설정

Directory 구조pom.xmlWebInitializer.javaApplicationConfig.javaMvcConfig.javareferenceSwagger 개요 - https://www.boostcourse.org/web326/lecture/58988S

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

NESTJS로 Swagger 문서화 하기

오늘은 nestjs로 Swagger API 문서 만들었던 작업을 정리하려고 한다.지금껏 nodejs express를 이용해 여러 API들을 만들면서 항상 골칫거리였던 것이 API 문서화였다

2021년 1월 25일
·
2개의 댓글
post-thumbnail

django swagger (drf-yasg)

rest api 문서 자동화를 위해 swagger를 사용했습니다.스웨거 공식문서에는 pip install django-rest-swagger 를 install 하라고 해서 찾아보니,django-rest-swagger 은 패키지 관리가 잘 안되고 있는 것 같습니다.그래서

2021년 1월 22일
·
0개의 댓글

Swagger UI와 flask_restplus

flask에 swagger 붙이기

2020년 12월 3일
·
0개의 댓글

zsh: command not found: swag

env: os: macOS Catalina 10.15.7 terminal: zsh error: in: swag i out: zsh: command not found: swag solution: step1: o

2020년 11월 14일
·
0개의 댓글

API 문서 자동화 - Swagger

Swagger은 작성하기 어렵고 심지어 테스트까지 통과해야 문서가 만들어지는 Spring REST Docs와는 다르게 빠르고 쉬우면서 색깔까지 알록달록한 문서를 만들 수 있게 도와준다.설명하기 전에 Swagger가 무엇인지 아는가?개발자가 REST 웹 서비스를 설계,

2020년 11월 12일
·
3개의 댓글
post-thumbnail

Swagger 프로젝트 적용과 어노테이션

API들이 가지고 있는 스펙(spec)을 명세, 관리할 수 있는 프로젝트협업을 진행하거나 이미 만들어져 있는 프로젝트에 대해 유지보수를 진행하게 되면 구축되어 있는 API서버가 어떤 스펙을 가지고 있는지 파악해야한다. 이러한 스펙 들을 직접 문서로 작성하게 되면 API

2020년 10월 31일
·
0개의 댓글

[SpringBoot] Swagger를 통한 REST 요청에 전역 jwt 인증 설정 하기

안녕하세요,이 포스트는 Jwt 설정, Swagger설정이 이미 완료된 서비스에서 활용할 수 있는 방법을 소개합니다.그림과 같이 Swagger를 사용하면서 각 API마다 @ApiImplicitParam 을 통해 JWT를 받아왔었는데요

2020년 9월 15일
·
0개의 댓글
post-thumbnail

Spring Rest Docs와 Open Api (Swagger)

안녕하세요! 오늘은 Spring 진영의 문서화 프레임워크인 Spring Rest Docs와 Swagger를 비교하는 글을 작성해 볼까 합니다. Peloton 프로젝트 진행 중에 문서화와 관련해서 고민했던 부분들을 정리 해보았어요. 함께 공유해보면 좋을 것 같아요.Spr

2020년 9월 14일
·
2개의 댓글

[Swagger] Multi @ApiResponse에 동일 코드 사용시 나타나는 에러

안녕하세요. Swagger를 통해 Api문서를 정리하다 신기한 점을 발견하고, 이를 해결했던 방법에 대해 설명하려 합니다.

2020년 8월 28일
·
1개의 댓글
post-thumbnail

기업협업(위잇딜라이트) 후기

DRF를 사용하여 제작을 해볼수 있는 소중한 기회였다. 하지만 처음 사용하여서 Serializer가 무엇인지 어떤걸 해주는지 몰랐기에 공홈과 블로그 들을 참고하여 공부를 진행하였다. DRF 를 사용하기 전에 CRUD를 만들기위해선 많은 코드를 작성해야했는데 DRF를 사

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

서버 API 문서화(Spring Rest docs)

서버 Api 문서화 with Spring Rest Docs

2020년 8월 15일
·
0개의 댓글

Swagger

&&> \- test할 수 있는 목업API백엔드 개발자와 프론트엔드 개발자의 소통 도구개발자는 인터페이스로 소통인터페이스 정의가 명확했다면 각자의 몫을 만들면 완성!IPO 관점에서 문서 정리Input ProcessOutPutAPI 정의, 공유, Test, 문서화에 적합

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

RESTful API💡: 나의 swag😎 swagger!

swagger를 이용해보자! 1편 (https://real-dongsoo7.tistory.com/58)

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

Swagger로 API 문서 자동화

REST API를 만들 때 문서화를 잘하는 것은 중요하다.더우기 API를 변경할 때마다 레퍼런스 문서에 똑같이 명시해주어야한다. 이것을 수작업으로 반영하는 것은 매우 지루한 일이므로, 이것을 자동화하는 것은 필수다.Swagger를 통해 spirng api 문서 자동화를

2020년 4월 19일
·
0개의 댓글