http 통신

이제 디비와 연결했으니 디비에 저장할 데이터를 가져와야겠죠?

저는 공공데이터포털에서 데이터를 가져올 예정입니다.

여러분들도 공공데이터포털에 들어가서 자신이 원하는 api를 찾아보고 사용하시면 될 것 같습니다.

http 통신을 하기 위해서 패키지를 설치해야 합니다.

패키지 설치 방법은

npm install 패키지이름

이렇게 이루어집니다. 저는 axios라는 라이브러리 설치할 예정입니다.

nestjs 홈페이지가면 nest/axios 라고 있습니다. 그걸 설치하면 됩니다.

npm i --save @nestjs/axios axios

이렇게 한다음 내가 http 통신 비지니스로직을 작성할 서비스파일에 httpservice 임폴트, 상단 모듈에서 http모듈을 임폴트에서 넣으시면 됩니다.

서비스에도 작업해줍니다.

이제 api 함수를 만들어보겠습니다.

import { Injectable, Logger } from '@nestjs/common';
import { HttpService } from '@nestjs/axios';

@Injectable()
export class FranchiseApiService {
     private readonly logger = new Logger(FranchiseApiService.name);

    constructor(private httpService: HttpService) {}


    async fetchingFranchiseApi({ year, pageNo = 1, numOfRows = 100 }: { year: string; pageNo?: number; numOfRows?: number }) {
 const options = {
   method: 'GET',
   url: 'https://franchise.ftc.go.kr/api/search.do',
   params: {
     type: 'list',
     yr: year,
     serviceKey: '비공개키', // 원본 키 사용 (+ 그대로)
     pageNo,
     numOfRows
   },
   headers: {
     'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8',
     'Accept-Language': 'ko-KR,ko;q=0.9,en;q=0.8',
     'Accept-Encoding': 'gzip, deflate, br',
     'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
     'Cache-Control': 'max-age=0',
     'Sec-Fetch-Dest': 'document',
     'Sec-Fetch-Mode': 'navigate',
     'Sec-Fetch-Site': 'none',
     'Sec-Fetch-User': '?1',
     'Upgrade-Insecure-Requests': '1'
   }
 };

 try {
   this.logger.log(`API 요청 시작: year=${year}, page=${pageNo}, rows=${numOfRows}`);
   
   const response = await this.httpService.axiosRef.get(options.url, { 
     params: options.params, 
     headers: options.headers 
   });
   
   this.logger.log(`프랜차이즈 API 응답 성공: status=${response.status}`);
   
   // XML 데이터 확인용 로그
   if (response.data.includes('<totalCount>')) {
     const totalCount = response.data.match(/<totalCount>(\d+)<\/totalCount>/)?.[1];
     this.logger.log(`총 데이터 개수: ${totalCount}`);
   }
   
   return response.data;
   
 } catch (error) {
   this.logger.error(`프랜차이즈 API 요청 실패: ${error.message}`);
   throw new Error(`프랜차이즈 API 요청 실패: ${error.message}`);
 }
}
}

파라미터의 경우 내가 사용하는 api에서 요청하는 파라미터를 작성하는 것이고

헤더의 경우는 나의 접속 환경을 표시할 수 있고, 키도 넣을 수 있습니다. 특정 웹사이트는 크롤링으로 인해 봇 접근을 막을 수 있어서

헤더에 일반 웹페이지 사용자라고 보여지기 위해 저렇게 해더를 작성했습니다. 그럼 이제 api를 테스트 해봐야겠죠?

nest 명령어를 통해 컨트롤러를 생성 합니다.

import { FranchiseApiService } from './franchise-api.service';
import { Controller, Get } from '@nestjs/common';

@Controller('franchise-api')
export class FranchiseApiController {
    constructor(private readonly franchiseApiService: FranchiseApiService) {}

    @Get()
    async franchiseApiTest() {

        const data = await this.franchiseApiService.fetchingFranchiseApi({ year: '2023', pageNo: 1, numOfRows: 10 });

        return { message: 'Franchise API data', data: data };
    }

}

이렇게 테스트할 수 있는 api를 코딩하고 테스트는 터미널 또는 포스트맨 프로그램, 웹사이트에서 할 수 있습니다.

저는 포스트맨 프로그램으로 테스트 해보겠습니다.

이런식으로 http status가 200 ok가 나오면서 데이터가 정상적으로 나오면 api 요청이 성공한 것입니다.