API
NestJS 기초 (11) API 문서 작성하기 (스웨거)
API 문서는 보통 개발한 API 기능을 명시하고 다른 개발자와 공유하기 위해 사용합니다. Nest에서는 스웨거(swagger)를 사용하여 간편하게 API 문서를 작성하고 이를 테스트해볼 수 있습니다. 스웨거 설치하기 다음 명령어로 스웨거를 설치합니다. npm install --save @nestjs/swagger swagger-ui-express API 문서 작성하기 스웨거 설치가 완료됐다면 이제 다음과 같이 main.ts 파일을 업데이트해줍니다. 타이틀이나 설명 등은 프로젝트에 맞게 수정하시면 됩니다. //main.ts import { NestFactory } from '@nestjs/core'; import { DocumentBuilder, SwaggerModule } from '@nestjs/sw..
Express (3) API 사용하기
이번 포스팅에서는 Express를 통해 외부 API를 호출하고, 응답을 전달 받아 표시하는 방법에 대해 알아보도록 하겠습니다. Express에서 API를 사용하는 여러 방법이 있지만 node에서 기본적으로 제공하는 https를 사용할 수 있습니다. API 호출하기 (비트코인 가격 조회) 이번 예시에서는 바이낸스 거래소 API를 사용하여 비트코인(BTC) 가격을 가져와보도록 하겠습니다. 아래처럼 코드를 작성하고 하고 로그를 찍어보면 요청한 API에 대한 모든 응답을 확인할 수 있습니다. const express = require("express"); const https = require("https"); const app = express(); app.get("/", function(req, res){ ..
RESTful API 정리
RESTful API란 무엇이며 어떻게 작동할까요? 이를 이해하려면 먼저 API의 의미를 알고 REST와 RESTful의 뜻에 대해 알아야 합니다. API란? API는 Application Programming Interface를 의미합니다. 이는 다른 소프트웨어 시스템과 통신하기 위한 규칙입니다. 저 멀리에 있는 알 수 없는 누군가와 통신을 하고 싶다고 생각해보세요. 서로가 각자의 방식으로 통신 방식을 구현한다면 메시지를 주고 받을 수 없을 것입니다. 정확한 통신을 위한 일종의 규칙이 필요하겠죠. 이것이 바로 API의 역할입니다. 웹 API는 클라이언트와 서버를 연결하는 게이트웨이라 할 수 있습니다. REST란? REST(Representational State Transfer)란 API 작동 방식을 ..
