목록swagger (5)

개발이 취미인 사람

[Nest.js] Nest.js API 만들기 (12) - API 문서화(Swagger)

- 개요 안녕하세요. 이번 시간에는 지난 시간까지 만들었던 API 서버에 문서화를 진행해보겠습니다. Nest.js에는 OpenAPI Swagger를 지원합니다. Swagger를 활용해서 API 문서화를 진행하겠습니다. 혹시 Swagger에 대해 잘 모르시는 분들은 아래 링크를 통해 학습하고 오시는 걸 추천드리겠습니다. [Swagger] Swagger UI를 활용한 내부 API Client 구축 [Swagger] Swagger UI를 활용한 내부 API Client 구축 - 개요 안녕하세요. 이번 글에서는 Swagger UI를 활용한 API 문서화 및 Client 서버 구축에 대해서 알아보겠습니다. 일단 Swagger라는 기술은 API를 설계하고 문서화를 해주는데 도움을 주는 기술입니다. any-ting...
백앤드(Back-End)/Nest.js 2021. 12. 26. 18:29
[Swagger] Node.js Swagger API 문서화

- 개요 안녕하세요. 이번 시간에는 Node.js API 서버에서 Swagger를 활용한 문서화 작업을 해보는 시간을 가져보도록 하겠습니다. 기본적으로 프론트 앤드와 백앤드 개발자가 작업을 할 때 가장 많이 협업하는 부분은 아무래도 클라이언트와 서버 간에 통신 부분입니다. 예전에는 git이나 구글 doc, wiki 등 텍스트 문자를 통해 API 문서를 정의해 공유했습니다. (보기가 불편하다는 단점이 가장 큰 것 같아요..) 최근에는 Postman을 통해 API를 정의하고 공유하는 방식도 많이 사용합니다. 하지만 우리 API 서버 정보가 Postman 서버에 저장되기 때문에 또 다른 문제가 발생합니다... 이러한 문제를 Swagger를 활용해 자체 API 서버에 연결을 한다면 해결이 가능합니다. 하지만 항..
백앤드(Back-End)/Swagger 2021. 10. 4. 04:40
[Swagger] Swagger Yaml 파일 RESTFul API 클라이언트 구축

- 지난 시간 안녕하세요. 지난 시간에는 Swagger Yaml 파일 기본 작성법에 대해 알아봤습니다. 놓치고 오신 분들은 한번 아래 링크를 통해 학습하고 오시는 걸 추천드립니다. any-ting.tistory.com/12 [Swagger] Swagger Yaml 기본 파일 작성 - 지난 시간 지난 시간에는 Swaager UI를 구축하는 시간을 가졌습니다. 혹시 구축하지 않으셨다면 아래 링크를 보고 구축하고 오시면 되겠습니다. any-ting.tistory.com/11 [Swagger] Swagger UI를 활용한 내부 A any-ting.tistory.com - 개요 이번 시간에는 실제 RESTFul API 구조에 맞게 하나씩 만들어 보도록 하겠습니다. 결과 화면을 먼저 보여드리도록 하겠습니다. 기본적..
백앤드(Back-End)/Swagger 2021. 1. 28. 23:34
[Swagger] Swagger Yaml 기본 파일 작성

- 지난 시간 지난 시간에는 Swaager UI를 구축하는 시간을 가졌습니다. 혹시 구축하지 않으셨다면 아래 링크를 보고 구축하고 오시면 되겠습니다. any-ting.tistory.com/11 [Swagger] Swagger UI를 활용한 내부 API Client 구축 - 개요 안녕하세요. 이번 글에서는 Swagger UI를 활용한 API 문서화 및 Client 서버 구축에 대해서 알아보겠습니다. 일단 Swagger라는 기술은 API를 설계하고 문서화를 해주는데 도움을 주는 기술입니다. any-ting.tistory.com - 개요 이번 시간에는 yaml 기본 파일 작성법에 대해서 알아보고 클라이언트 UI를 만들어 보도록 하겠습니다. Swagger를 사용하면서 가장 좋은 장점은 RESTful API를 문..
백앤드(Back-End)/Swagger 2021. 1. 12. 12:24
[Swagger] Swagger UI를 활용한 내부 API Client 구축

- 개요 안녕하세요. 이번 글에서는 Swagger UI를 활용한 API 문서화 및 Client 서버 구축에 대해서 알아보겠습니다. 일단 Swagger라는 기술은 API를 설계하고 문서화를 해주는데 도움을 주는 기술입니다. 이해가 안 가고 머릿속에 그려지지 않으실 거예요. 저도 처음에는 무슨 소리인 건지 하는 생각이 들었었어요. 하지만 UI를 확인해보면 우리가 생각했던 RESTful API 설계하고 문서화를 할 수 있는 기술이라는 걸 알 수 있었어요. :) 이 글에서는 Swagger UI를 구축하고 yaml 파일을 작성해서 RESTful API를 만들어 보겠습니다. - 구축 공식 홈페이지 : swagger.io/tools/swagger-ui/ REST API Documentation Tool | Swagg..
백앤드(Back-End)/Swagger 2021. 1. 11. 21:17
이전 Prev 1 Next 다음