API활용

API활용

유형
실습문서
주제

레시피앱제작

순번
7
태그
설명

1. 시작파일

파일다운로드

파일활용방법

만약 이전 파일이 없을 경우 아래의 파일을 다운로드 하여 진행한다

시작 파일

#2. 연관링크

🔗

연관링크

API란?

fetch와 promise 예제

MDN fetch

MDN try...catch 문

axios 공식홈

#3. fetch

fetch()

fetch 함수는 웹에서 데이터를 요청하고 받아오는 자바스크립트 기능이다.

간단하게는 fetch('주소')를 사용해 데이터를 요청하고, .then()을 통해 받은 데이터를 처리한다

우리의 레시피 앱은 자바스크립트의 fetch() 함수를 사용하는것이 정석이긴 하지만 어려우므로 axios 라이브러리를 사용해서 제작 할 것이다.

하지만 fetch 를 전혀 모르면 안되므로 기본적인 문법은 알아보도록 하자

#3.1. fetch 함수 간단맛보기

  1. 🔗더미데이터 사이트 로 이동한다.
  2. json 데이터를 확인한다. 데이터의 가독성이 안 좋을 경우 이미지의 표시된 부분을 클릭한다.
  3. image
  4. vscode 에서 fatch.js 파일을 생성후 코드를 작성한다.
  5. src/fetch.js

    let response = fetch('https://jsonplaceholder.typicode.com/posts').then((res) => {
    	console.log(res);
    });
    

    1

    2

    3

promise 객체를 사용해서 반환되는 함수들은 then을 통해서 호출할수 있다.

  1. 콘솔확인
  2. image
  3. fetch 를 통해 반환되는 값은 우리가 원하는 결과값이 아닌 성공객체 자체 를 반환하므로 우리가 원하는 형태와 다르다.편지를 보내고 답장을 받을때 봉투에 담겨 있는것과 같다
  4. 봉투안의 편지를 꺼내듯 데이터 꺼내어 출력 해야 한다.async await 는 then을 간결히 작성할수 있게한다
  5. src/fetch.js

    async function getData() {
     let rawResponse = await fetch('https://jsonplaceholder.typicode.com/posts');
     let jsonResponse = await rawResponse.json();
     console.log(jsonResponse);
    }
    getData();
    

    1

    2

    3

    4

    5

    6

    image

#3.2. 앱에 fetch 적용해보기

  1. 이번에는 우리의 앱에 실제 네트워크 통신이 되는 데이터를 연결해보자
  2. src 폴더에 fetch.js 파일에 fetchDB 모듈을 추가하고 내용을 아래와 같이 작성한다.

    fetch.js

    export const fetchDB = async () => {
     try {
     	let res = await fetch('https://jsonplaceholder.typicode.com/posts');
     	let db = await res.json();
     	return db;
     } catch (error) {
     	console.error(error);
     }
    };
    

    1

    2

    3

    4

    5

    6

    7

    8

    9

  3. App.js 에 fetchDB 를 임포트한다
  4. App.js

    import { useState, useEffect } from 'react';
    import { fetchDB } from './fetch';
    
    function App() {
     const [loading, setLoading] = useState(true);
     const [data, setData] = useState([]);
     useEffect(() => {
     	const loadDB = async () => {
     		const db = await fetchDB();
     		setLoading(false);
     		setData(db);
     		console.log(db);
     	};
     	loadDB();
     	//삭제	setTimeout(() => {
     	//	}, 500);
     }, []);
    
     return (
     	<div className='App'>
     		return <div className='App'>{loading ? <h1>로딩중입니다...</h1> : <h1>도레미레시피</h1>}</div>;
     	</div>
     );
    }
    
    export default App;
    

    1

    2

    3

    4

    5

    6

    7

    8

    9

    10

    11

    12

    13

    14

    15

    16

    17

    18

    19

    20

    21

    22

    23

    24

    25

    26

  5. 콘솔로그를 확인해보자
  6. image

    100개의 데이터가 확인된다 이 데이터는 fetchDB에서 전달받은 것이다.

  7. 코드설명
  8. 줄번호
    코드설명
    8
    loadDB 함수에 서버와 비동기 통신을 하고 컴포넌트의 상태플 변경하는 기능을 예엑한다.
    9
    서버와 통신시 서버 상황에 따라 응답속도의 차이가 있을수 있으므로 데이터를 요청하는 함수는 비동기로 작성한다.
    10-11
    컴포넌트의 로딩과 데이터의 상태를 관리하는 함수이다.
    12
    9번에서 응답받은 결과를 확인한다.
    14
    8번에서 예약한 함수를 호출한다.
  9. data 를 화면에 표시하기
return (
	<div className='App'>
		{loading ? (
			<h1>로딩중입니다...</h1>
		) : (
			data.map((el) => {
				return (
					<ul key={el.id}>
						<li style=red>{el.userId}</li>
						<li>{el.title}</li>
						<li>{el.body}</li>
					</ul>
				);
			})
		)}
	</div>
);

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

#4. 공공 API 신청

  1. 🔗식품안전나라 회원가입을 한다.
  2. 검색창에 레시피 입력후 해당 리스트 클릭
  3. image
  4. OPEN-API 탭 클릭
  5. image
  6. 인증키발급신청 클릭
  7. image
  8. 약관동의 후 활용목적을 간단히 기재한다.
  9. image
  10. 1~2일 이후 회원 가입시 작성한 이메일이나 식품안전나라의 인증키 신청현황에서 발급된 키를 확인한다.

#5. Axios

#5.1. API 연결하기

  1. API 요청주소 살펴보기
  2. API요청주소는 로그인시에만 공개되므로 하단의 링크를 이용하여 확인한다.

    요청주소확인하기

    image
  3. 요청주소의 샘플주소를 복사하여 주소창에 넣으면 데이터가 확인된다.
  4. URL뒤에 원하는 데이터를 요청인자표를 보고 파라미터로 전달하면 원하는 데이터를 골라서 받을수 있다.
  5. image
  6. 데이터 확인해보기
  7. 정말 그런지 API를 바로 사용해 보자.

    fetch.js에 작성한다.

    fetch.js

    //let res = await fetch('https://jsonplaceholder.typicode.com/posts');
    // 인증키=발급받은api키 / 서비스명=COOKRCP01 / 요청파일타입=json / 요청시작위치=1 / 요청종료위치=100
    let res = await fetch('http://openapi.foodsafetykorea.go.kr/api/인증키/COOKRCP01/json/1/100');
    

    1

    2

    3

  8. 실행화면 보기
  9. 컴포넌트에는 데이터의 키가 맞지 않아 당연히 오류가 난다.

    콘솔창을 확인하면 통신결과는 성공으로 확인되며 100개의 레시피 데이터가 확인된다.

    image

#5.2. Axios 설치

Axios란 브라우저와 Node.js 환경에서 사용할 수 있는 비동기 HTTP 통신 라이브러리.

Axios를 사용하면 HTTP 요청을 쉽게 보내고 응답을 처리할 수 있으며, Promise API를 기반으로 비동기 작업을 용이하게 한다.

Axios는 GET, POST, PUT, DELETE 등의 HTTP 메서드를 모두 지원하며, 요청과 응답을 JSON 형태로 자동 변환해준다.

  1. axios 설치하기실행중인 개발서버를 닫고 라이브러리 설치후 재실행한다.
  2. npm i axios
    npm start
    
  3. 아래의 코드를 작성하여 데이터를 axios를 임포트 한다.3번라인 삭제.
  4. App.js

    import axios from 'axios';
    import { useState, useEffect } from 'react';
    //import { fetchDB } from './fetch';
    

    1

    2

    3

#5.3. 레시피데이터 받아오기

위에서 언급했듯 서버에서 제공하는 데이터를 받아오는 작업은 컴포넌트를 렌더링 하는 작업에 비해 시간이 오래 걸리므로 비동기식으로 작성한다.

  1. 데이터를 받아오는 함수 getDB 에 async를 할당한다.서버와의 통신중 오류상황에 대비하여 try~catch 문 으로 예외처리를 작성한다.
  2. App.js

     ...
     function App() {
     const [loading, setLoading] = useState(true);
     const [data, setData] = useState([]);
    const getDB = async () => {
     try {
     	const DB = await axios.get('http://openapi.foodsafetykorea.go.kr/api/발급받은 서비스키/COOKRCP01/json/1/100');
     	console.log(DB); // 응답 데이터 확인.
     } catch (error) {
     	console.error('데이터를 불러오는데 실패했습니다.', error);
     }
    };
    //useEffect로 컴포넌트 마운트시 getDB함수를 호출한다.
    useEffect(() => {
     getDB();
     setLoading(false);
    }, []);
    

    1

    2

    3

    4

    5

    6

    7

    8

    9

    10

    11

    12

    13

    14

    15

    16

    17

  3. 결과확인서버에서 다양한 데이터를 전달하고 있는것이 확인된다.이중 우리가 원하는 값은 data.COOKRCP01.row에 배열형태로 반환되었다.
  4. image

#6. 레시피 데이터 화면에 그리기

#6.1. 객체에 있는 키에 조금 더 똑똑하게 접근하기

  1. data.COOKRCP01.row 에서 일단 data 까지 구조분해할당으로 꺼내보자
  2. App.js

    ...
    function App() {
     const [loading, setLoading] = useState(true);
     const [data, setData] = useState([]);
     const getDB = async () => {
     	try {
     		const { data } = await axios.get('http://openapi.foodsafetykorea.go.kr/api/08cc9b42270a4439b1b5/COOKRCP01/json/1/100');
     		console.log(data);
    ...
    

    1

    2

    3

    4

    5

    6

    7

    8

    9

  3. 콘솔메시지는 1초 정도 기다리면 확인된다.
  4. image
  5. 상태관리를 여러개 할 경우 객체를 활용하여 간단히 관리할수 있다. 두개의 스위치로 각각 제어하던 전등을 하나의 멀티 스위치로 관리한다고 이해하면 쉽다. 이때 사용하는 자료형이 자바스크립트의 객체형이다.
  6. loading,setLoadng의 초기값을 객체로 관리한다.

    App.js

    const [loading, setLoading] = useState({ state: true, data: [] });
    

    1

    image
    image
  7. 컴포넌트에 그리기
  8. App.js

    ...
    const getDB = async () => {
     try {
     	const { data } = await axios.get('http://openapi.foodsafetykorea.go.kr/api/발급받은 서비스키/COOKRCP01/json/1/100');
     	setLoading({ state: false, data: data.COOKRCP01.row });
     	console.log(data);
     } catch (error) {
     	console.error('데이터를 불러오는데 실패했습니다.', error);
     }
    };
    useEffect(() => {
     getDB();
    }, []);
    return (
    <div className='App'>
     {loading.state ? (
     	<h1>로딩중입니다...</h1>
     ) : (
     	loading.data.map((a) => (
     		<div key={a.RCP_SEQ}>
     			<span style=red>{a.RCP_NM}</span>
     			<span>{a.RCP_WAY2}</span>
     		</div>
     	))
     )}
    </div>
    ...
    

    1

    2

    3

    4

    5

    6

    7

    8

    9

    10

    11

    12

    13

    14

    15

    16

    17

    18

    19

    20

    21

    22

    23

    24

    25

    26

    27

  9. 결과확인
  10. image

#6.2. 코드개선하기(Refactoring)

  1. setLoading({ state: false, data: data.COOKRCP01.row }); 이 부분을 구조분해할당으로 줄여보자.data 를 한번더 분해해서 row키의 데이터만 추출하면 더욱 간결한 코드를 구현할수 있다.
  2. App.js

    function App() {
    	const [loading, setLoading] = useState({ state: true, data: [] });
    	const getDB = async () => {
    		try {
    			const {data} = await axios.get('http://openapi.foodsafetykorea.go.kr/api/발급받은 서비스키/COOKRCP01/json/1/100');
    			const {	COOKRCP01: { row } } = data;
    			setLoading({ state: false, data: row });
    		} catch (error) {
    			console.error('데이터를 불러오는데 실패했습니다.', error);
    		}
    	};
    	useEffect(() => {
    		getDB();
    	}, []);
    	return (
    	<div className='App'>
    		{loading.state ? (
    			<h1>로딩중입니다...</h1>
    		) : (
    			loading.data.map((el) => (
    				<div key={el.RCP_SEQ}>
    					<span style=red>{el.RCP_NM}</span>
    					<span>{el.RCP_WAY2}</span>
    				</div>
    			))
    		)}
    	</div>
    );
    ...
    

    1

    2

    3

    4

    5

    6

    7

    8

    9

    10

    11

    12

    13

    14

    15

    16

    17

    18

    19

    20

    21

    22

    23

    24

    25

    26

    27

    28

    29

#6.3. 필요한 데이터만 추출하여 업데이트 하자

  1. 응답데이터의 구조를 살펴보고 구조에 맞게 키를 넣어 컴포넌트에 렌더링 시켜보자.키에 해당하는 내용은 OPEN-API 페이지 하단의 출력항목 표에서 확인할수 있다
  2. image

    App.js

    ...
    const {	COOKRCP01: { row } } = data;
    setLoading({ state: false, data: row });
    console.log('data', loading.data);
    ...
     loading.data.map((el) => (
     	<div key={el.RCP_SEQ}>
     		<span style=red>{el.RCP_NM}</span>
     		<span>{el.RCP_WAY2}</span>
     		<div>
     			<span>{el.MANUAL01}</span>
     			<span>{el.MANUAL02}</span>
     			<span>{el.MANUAL03}</span>
     		</div>
     	</div>
    

    1

    2

    3

    4

    5

    6

    7

    8

    9

    10

    11

    12

    13

    14

    15

    image
  3. 앱을 실행해 보면 처음에는 isLoading... 이 화면에 나타나다가, 데이터가 화면에 렌더되는것을 볼수있다
  4. 주의) 가끔 API가 오작동하며 axios.get()이 제대로 실행되지 않을 수도 있다. 그런 경우에는 1~2분 정도 기다렸다가 다시 리액트 앱을 실행해 보자.

#7. 여기까지 깃허브에 올리기

git add .
git commit -m "07 api 연결"
git push origin main

1

2

3

#8. 완료파일 내려받기

완료 파일

리액트reactnodejsnode