Flask-RESTful 및 Swagger: Python 웹 애플리케이션에서 RESTful API를 구축하기 위한 모범 사례(2부)

Flask-RESTful 및 Swagger: Python 웹 애플리케이션에서 RESTful API를 구축하기 위한 모범 사례(2부)

이전 기사에서는 Flask-RESTful 및 Swagger 사례를 사용하여 RESTful API를 구축하기 위한 모범 사례를 살펴보았습니다. Flask-RESTful 프레임워크의 기본 사항을 소개하고 Swagger를 사용하여 RESTful API에 대한 문서를 작성하는 방법을 보여주었습니다. 이 기사에서는 이러한 주제를 계속해서 자세히 살펴보고 더욱 발전된 기술과 사례를 소개합니다.

1. 권한 부여 및 인증 사용

RESTful API는 승인된 사용자만 액세스할 수 있도록 안전해야 합니다. 이를 달성하려면 권한 부여 및 인증을 사용해야 합니다. 권한 부여는 사용자가 리소스에 액세스할 수 있는지 여부를 결정하는 프로세스입니다. 인증은 사용자의 신원을 확인하는 프로세스입니다.

Flask-RESTful은 매우 유용한 확장인 Flask-JWT를 제공합니다. Flask-JWT는 토큰 기반 인증 및 권한 관리를 구현하는 데 도움이 될 수 있습니다. 여기서는 Flask-JWT를 사용하여 토큰 인증을 구현하는 방법을 간략하게 소개합니다.

from flask import Flask
from flask_jwt import JWT, jwt_required, current_identity
from werkzeug.security import safe_str_cmp

app = Flask(__name__)
app.config['SECRET_KEY'] = 'super-secret'

class User:
   def __init__(self, id, username, password):
      self.id = id
      self.username = username
      self.password = password

   def __str__(self):
      return "User(id='%s')" % self.id

users = [
   User(1, 'john', 'pass'),
   User(2, 'susan', 'pass'),
]

username_table = {u.username: u for u in users}
userid_table = {u.id: u for u in users}

def authenticate(username, password):
   user = username_table.get(username, None)
   if user and safe_str_cmp(user.password.encode('utf-8'), password.encode('utf-8')):
      return user

def identity(payload):
   user_id = payload['identity']
   return userid_table.get(user_id, None)

jwt = JWT(app, authenticate, identity)

@app.route('/protected')
@jwt_required()
def protected():
   return '%s' % current_identity

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

위 코드에서는 Flask 애플리케이션에 연결되는 JWT 객체를 생성합니다. JWT 객체는 Flask 앱의 SECRET_KEY를 사용하여 토큰을 암호화하고 해독합니다. 또한 사용자 클래스를 정의하고 사용자 정보는 사용자 목록에 저장됩니다.

인증 기능 authenitcate를 정의할 때 사용자 이름이 존재하는지 확인하고 비밀번호 정보를 전달합니다. 비밀번호 확인이 통과되면 함수는 사용자 개체를 반환합니다. ID 함수 ID를 정의할 때 인증된 사용자 개체를 반환합니다.

@app.route('/protected') 데코레이터 아래에서 @jwt_required() 데코레이터는 이 엔드포인트를 보호하는 데 사용되어 인증되고 승인된 사용자만 액세스할 수 있도록 보장합니다.

2. 버전 제어 구현

버전 제어는 클라이언트와 서버 간의 상호 작용을 안정적이고 이전 버전과 호환되게 만들기 때문에 매우 중요한 개념입니다. API는 특히 API가 크게 변경되는 경우 클라이언트와 서버 간의 호환성을 최대한 유지해야 합니다. 버전 제어를 달성하려면 API에 버전 번호를 도입해야 합니다.

다음은 좋은 버전 관리 방법입니다.

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)
version = 'v1'

class HelloWorld(Resource):
    def get(self):
        return {'version': version, 'message': 'Hello World'}

api.add_resource(HelloWorld, f'/{version}/')

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

위 코드에서는 버전 변수를 정의하여 API 버전을 지정한 다음 @app.route 데코레이터에서 f-{version}-string을 사용하여 버전 번호. 이를 통해 버전 제어가 가능해지고 클라이언트와 서버 간의 인터페이스 호환성이 향상됩니다.

3. 다른 확장 사용

Flask-RESTful은 RESTful API를 더 빠르고 쉽게 구축하는 데 도움이 되는 다양한 확장성 플러그인을 제공합니다. 다음은 일반적으로 사용되는 확장 기능입니다.

• Flask-CORS: 애플리케이션의 도메인 간 액세스 문제를 해결합니다.
• Flask-Bcrypt: 비밀번호 암호화를 위한 bcrypt 비밀번호 해싱 기능을 제공합니다.
• Flask-Migrate: 데이터 마이그레이션 및 데이터베이스 업그레이드 기능을 제공합니다.
• Flask-Login: 사용자 로그인 기능을 제공합니다.

이러한 확장 기능은 RESTful API를 보다 효율적으로 구축하는 데 도움이 됩니다.

요약

이 문서에서는 Flask-RESTful 및 Swagger를 사용하여 RESTful API를 구축하는 방법에 대한 모범 사례를 자세히 살펴봅니다. API의 보안을 보장하기 위해 권한 부여 및 인증을 사용하는 방법과 버전 제어를 구현하는 방법을 소개했습니다. 동시에 더 나은 API 구축을 위해 일반적으로 사용되는 몇 가지 Flask 확장도 소개합니다. 이러한 사례는 RESTful API를 더 빠르게 구축하고 클라이언트와 서버 간의 상호 작용을 더욱 안정적이고 이전 버전과 호환되게 만드는 데 도움이 됩니다.

위 내용은 Flask-RESTful 및 Swagger: Python 웹 애플리케이션에서 RESTful API를 구축하기 위한 모범 사례(2부)의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!