Python 및 Flask를 사용하여 RESTful Web API를 구현하는 방법을 설명하는 예

아래 편집기는 Python 및 Flask를 사용하여 RESTful Web API를 구현하는 예를 제공합니다. 편집자님이 꽤 좋다고 생각하셔서 지금 공유하고 모두에게 참고용으로 드리도록 하겠습니다. 편집기를 따라가서 살펴보겠습니다.

환경 설치:

sudo pip install 플라스크

Flask는 WSGI 클래스 라이브러리인 Werkzeug를 기반으로 하는 Python 마이크로서비스 프레임워크입니다.

Flask 장점:

Python으로 작성(장점이 될 수 있음),
사용이 간편함,
유연함,
/articles/:id를 사용한 여러 가지 유용한 배포 옵션:

from flask import Flask, url_for
app = Flask(__name__)

@app.route('/')
def api_root():
 return 'Welcome'

@app.route('/articles')
def api_articles():
 return 'List of ' + url_for('api_articles')

@app.route(&#39;/articles/<articleid>&#39;)
def api_article(articleid):
 return &#39;You are reading &#39; + articleid

if __name__ == &#39;__main__&#39;:
 app.run()

요청: curl http://127.0.0.1:5000/

응답:

GET /

Welcome

GET /articles

/기사 목록

GET /articles/123

지금 읽고 있는 내용 123

REQUE STS

GET 매개변수

from flask import request

@app.route('/hello')
def api_hello():
 if 'name' in request.args:
  return 'Hello ' + request.args['name']
 else:
  return 'Hello John Doe'

요청:

GET /helloHello John DoeGET / hello?name=Luis

Hello Luis

요청 메소드(HTTP 동사)

@app.route('/echo', methods = ['GET', 'POST', 'PATCH', 'PUT', 'DELETE'])
def api_echo():
 if request.method == 'GET':
  return "ECHO: GET\n"

 elif request.method == 'POST':
  return "ECHO: POST\n"

 elif request.method == 'PATCH':
  return "ECHO: PACTH\n"

 elif request.method == 'PUT':
  return "ECHO: PUT\n"

 elif request.method == 'DELETE':
  return "ECHO: DELETE"

Request 지정 요청 유형:

curl -X PATCH http://127.0.0.1:5000/echoGET /echoECHO: GET

POST /ECHO

ECHO: POST

데이터 및 헤더 요청

from flask import json

@app.route('/messages', methods = ['POST'])
def api_message():

 if request.headers['Content-Type'] == 'text/plain':
  return "Text Message: " + request.data

 elif request.headers['Content-Type'] == 'application/json':
  return "JSON Message: " + json.dumps(request.json)

 elif request.headers['Content-Type'] == 'application/octet-stream':
  f = open('./binary', 'wb')
  f.write(request.data)
    f.close()
  return "Binary message written!"

 else:
  return "415 Unsupported Media Type ;)"

지정된 콘텐츠 유형 요청:

curl -H "Content-type: application/json" -X POST http://127.0.0.1:5000/messages -d '{ "message":"Hello Data"}'curl -H "Content-type: application/octet-stream"

-X POST http://127.0.0.1:5000/messages --data-binary @message.bin

RESPONSES

from flask import Response

@app.route('/hello', methods = ['GET'])
def api_hello():
 data = {
  'hello' : 'world',
  'number' : 3
 }
 js = json.dumps(data)

 resp = Response(js, status=200, mimetype='application/json')
 resp.headers['Link'] = 'http://luisrei.com'

 return resp

응답 보기 HTTP 헤더:

curl -i http://127.0.0.1: 5000/hello최적화 코드:

from 플라스크 가져오기 jsonify

사용

resp = jsonify(data)
resp.status_code = 200

바꾸기

resp = Response(js, status=200, mimetype='application/json')

상태 코드 및 오류

@app.errorhandler(404)
def not_found(error=None):
 message = {
   'status': 404,
   'message': 'Not Found: ' + request.url,
 }
 resp = jsonify(message)
 resp.status_code = 404

 return resp

@app.route(&#39;/users/<userid>&#39;, methods = [&#39;GET&#39;])
def api_users(userid):
 users = {&#39;1&#39;:&#39;john&#39;, &#39;2&#39;:&#39;steve&#39;, &#39;3&#39;:&#39;bill&#39;}
 
 if userid in users:
  return jsonify({userid:users[userid]})
 else:
  return not_found()

요청:

GET / users/2HTTP/1.0 200 확인 {"2": "스티브"

}

GET /users/4

HTTP/1.0 404 찾을 수 없음

{

"status": 404,

"message": " 찾을 수 없음: http://127.0.0.1:5000/users/4"
}

AUTHORIZATION

from functools import wraps

def check_auth(username, password):
 return username == 'admin' and password == 'secret'

def authenticate():
 message = {'message': "Authenticate."}
 resp = jsonify(message)

 resp.status_code = 401
 resp.headers['WWW-Authenticate'] = 'Basic realm="Example"'

 return resp

def requires_auth(f):
 @wraps(f)
 def decorated(*args, **kwargs):
  auth = request.authorization
  if not auth: 
   return authenticate()

  elif not check_auth(auth.username, auth.password):
   return authenticate()
  return f(*args, **kwargs)

 return decorated

check_auth 기능 교체 및 require_auth 데코레이터 사용:

@app.route(' /secrets')@requires_authdef api_hello():return "쉿 이건 일급 비밀 스파이!"

HTTP 기본 인증:

curl -v -u "admin:secret" http://127.0.0.1: 5000/secrets

간단한 디버그 및 로깅



디버그:

app.run(debug=True)

로깅:

import logging
file_handler = logging.FileHandler('app.log')
app.logger.addHandler(file_handler)
app.logger.setLevel(logging.INFO)

@app.route('/hello', methods = ['GET'])
def api_hello():
 app.logger.info('informing')
 app.logger.warning('warning')
 app.logger.error('screaming bloody murder!')
 
 return "check your logs\n"

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