목록api 문서화 (2)

개발이 취미인 사람

[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
이전 Prev 1 Next 다음