Flask로 간단한 GET API 만들기

Python의 Flask는 가볍고 사용하기 쉬운 웹 프레임워크로, 간단한 API를 빠르게 개발할 수 있습니다. 이 글에서는 Flask를 이용해 간단한 GET API를 만드는 방법을 단계별로 설명합니다.

1. Flask 설치하기

먼저 Flask를 설치해야 합니다. Python 패키지 매니저인 pip를 사용하여 설치합니다:

pip install flask

2. GET API 작성하기

다음은 간단한 Flask GET API 예제 코드입니다. 이 API는 사용자가 전달한 이름을 받아 환영 메시지를 반환합니다.

from flask import Flask, jsonify, request

app = Flask(__name__)

# 기본 GET API
@app.route('/api/greet', methods=['GET'])
def greet():
    name = request.args.get('name', 'World')  # URL 파라미터에서 'name' 값을 가져옴
    return jsonify({'message': f'Hello, {name}!'})

if __name__ == '__main__':
    app.run(debug=True)

코드 설명

• @app.route('/api/greet', methods=['GET']): /api/greet 경로에 대한 GET 요청을 처리합니다.
• request.args.get('name', 'World'): URL 파라미터로 전달된 name 값을 가져오며, 기본값은 'World'입니다.
• jsonify: Python 딕셔너리를 JSON 형식으로 변환하여 반환합니다.

3. 실행하기

위 코드를 app.py라는 파일로 저장한 후, 터미널에서 다음 명령어를 실행합니다:

python app.py

Flask 서버가 시작되며, 기본적으로 http://127.0.0.1:5000에서 실행됩니다.

4. API 테스트하기

웹 브라우저나 도구(Postman, curl)를 사용하여 API를 테스트할 수 있습니다.

브라우저에서 테스트

• 기본 요청: http://127.0.0.1:5000/api/greet
• 이름 추가: http://127.0.0.1:5000/api/greet?name=Alice

결과:

{"message": "Hello, Alice!"}

curl로 테스트

curl "http://127.0.0.1:5000/api/greet?name=Bob"

결과:

{"message": "Hello, Bob!"}

Postman으로 테스트

1. Postman을 열고 새 GET 요청을 생성합니다.
2. URL에 http://127.0.0.1:5000/api/greet를 입력합니다.
3. URL 파라미터로 name을 추가하여 테스트합니다.

5. 확장 아이디어

이 예제를 기반으로 다양한 기능을 추가할 수 있습니다:

• POST, PUT, DELETE와 같은 다른 HTTP 메서드 지원.
• 데이터베이스 연동 (예: SQLite, PostgreSQL).
• Docker를 이용한 배포.

Flask는 초보자부터 전문가까지 모두에게 적합한 웹 프레임워크입니다. 이 글을 통해 Flask로 첫 API를 성공적으로 만들어보길 바랍니다!