Flask를 사용하여 RESTful API를 구축하는 방법

오늘날의 소프트웨어 개발 분야에서 RESTful API는 안정적이고 분리되며 유지 관리가 쉬운 서비스를 제공할 수 있는 많은 애플리케이션의 핵심 구성 요소가 되었습니다. Flask는 웹 애플리케이션과 RESTful API를 구축하는 유연한 방법을 제공하는 경량 Python 웹 프레임워크입니다. 이번 글에서는 Flask를 사용하여 RESTful API를 구축하는 방법을 소개하겠습니다.

1. Flask 설치

먼저 Python과 pip가 설치되어 있는지 확인해야 합니다. 시스템에서 터미널 또는 명령 프롬프트를 열고 다음 명령을 입력하여 Flask를 설치합니다.

pip install Flask

2. 프로젝트 폴더 생성

이 예에서는 "flask-restful"이라는 프로젝트 폴더를 생성합니다. 폴더를 생성하려면 터미널에 다음 명령을 입력하세요:

mkdir flask-restful

3. 가상 환경 생성

시스템에 전역적으로 Flask를 설치하지 않도록 가상 환경을 사용하는 것이 좋습니다. 이렇게 하면 동일한 시스템에서 여러 프로젝트를 개발하는 데 도움이 됩니다. 컴퓨터. 가상 환경을 생성하려면 터미널에 다음 명령을 입력하세요:

python3 -m venv env

4. 가상 환경 활성화

터미널에서 가상 환경을 활성화하려면 다음 명령을 입력하세요.

Mac/Linux의 경우:

source env/bin/activate

Windows의 경우:

envScriptsctivate

5. 필요한 종속성 추가

Flask 애플리케이션에서는 RESTful API 요청을 안전하게 수행하려면Flask_restful 라이브러리 및 기타 라이브러리를 사용해야 합니다. 이러한 종속성은 가상 환경에서 pip 명령을 사용하여 설치할 수 있습니다.

pip install flask_restful
pip install flask_cors

6. 애플리케이션 마스터 파일 생성

RESTful API를 생성하기 전에 애플리케이션 마스터 파일을 생성해야 합니다. 프로젝트 폴더에 "app.py"라는 파일을 생성하고 다음 코드를 추가합니다.

from flask import Flask
from flask_restful import Api, Resource, reqparse

app = Flask(__name__)
api = Api(app)

users = [
    {
        "name": "Alice",
        "age": 22,
        "occupation": "Software Engineer"
    },
    {
        "name": "Bob",
        "age": 26,
        "occupation": "Data Analyst"
    },
    {
        "name": "Charlie",
        "age": 33,
        "occupation": "UI/UX Designer"
    }
]

class User(Resource):
    def get(self, name):
        for user in users:
            if(name == user["name"]):
                return user, 200
        return "User not found", 404

api.add_resource(User, "/user/<string:name>")

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

위 코드는 "app"이라는 Flask 애플리케이션 인스턴스와 "api"라는 플라스크_restful 개체를 생성합니다. 또한 사용자 정보를 저장하기 위한 일부 데이터를 정의합니다. 이 애플리케이션에서는 플라스크_restful의 "Resource" 클래스에서 상속되는 "User"라는 클래스도 정의합니다. User 클래스는 get과 post라는 두 가지 메서드를 정의합니다. 우리는 지정된 이름을 가진 사용자 데이터를 얻는 데 사용되는 get 메소드만 구현했습니다. 마지막으로 User 클래스를 API의 /user/df64b2f2eaba890373bab527a3e6d187 엔드포인트에 바인딩합니다.

7. 애플리케이션 실행

터미널 또는 명령 프롬프트에서 다음 명령을 입력하여 애플리케이션을 시작하세요.

python app.py

그런 다음 http://localhost:5000/user/Alice(또는 다른 사용자 이름)를 방문하세요. 사용자 데이터를 사용할 수 있습니다.

8. CORS 지원 추가

CORS는 Cross-Origin Resource Sharing을 의미합니다. RESTful API를 사용하는 경우 개발 환경에서 CORS 지원을 사용하여 도메인 간 리소스 문제를 방지할 수 있습니다. 우리 애플리케이션에서는 플라스크_cors 라이브러리를 사용하여 CORS 지원을 추가했습니다. CORS 지원을 추가하려면 애플리케이션 기본 파일에 다음 코드를 추가하기만 하면 됩니다.

from flask_cors import CORS

app = Flask(__name__)
api = Api(app)
CORS(app)

이 코드는 애플리케이션 인스턴스 및 API 정의 뒤에 추가됩니다. CORS 미들웨어를 애플리케이션 인스턴스에 바인딩합니다.

결론

이 글에서는 Flask를 사용하여 RESTful API를 구축하는 방법을 소개했습니다. Flask 설치부터 시작하여 프로젝트 폴더, 가상 환경을 생성하고 종속성을 추가하고 애플리케이션 메인 파일을 생성합니다. 또한 교차 출처 리소스 요청 문제를 해결하는 데 도움이 되도록 CORS 지원을 추가하는 방법도 배웠습니다. 이제 Flask를 사용하여 RESTful API 서비스를 쉽게 구축할 수 있습니다.

위 내용은 Flask를 사용하여 RESTful API를 구축하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!