Flask API 기본 정의 방법

kjoo0·2024년 1월 21일

Flask 애플리케이션을 처음 개발하면서 python의 간단함(?)을 실감한다.

Flask에서 시작점이 되는 app.py는 간단한 프로그램에서는 다음과 같은 기능을 가진다.

  1. api 정의 부분
  2. db 호출

코드는 짧고 단순하지만
마냥 따라치기보다는, api 정의 부분을 정리해보려고 한다!

전체 코드

'render_template' 기능을 이용하여 html 템플릿을 렌더링하는 루트 URL을 정의하는 부분이다.

from flask import Flask, render_template, jsonify, request

app = Flask(__name__)

@app.route('/')
def home():
    return render_template('index.html')
  1. Importing Flask and MongoClient:

    from flask import Flask, render_template, jsonify, request
    • render_template: html 템플릿을 렌더링하는 함수
    • jsonify: 데이터를 파이썬 dic 에서 json 형태로 응답을 보내는 함수
    • request: 클라이언트가 보낸 정보를 캡슐화하는 객체(폼 or 쿼리 파라미터)
  2. Creating a Flask App:

    app = Flask(__name__)
    • flask에서 루트 경로를 찾기 위해 사용하는 일반적인 방법!
      클래스의 인스턴스를 생성하고, __name__이 인수로 전달한다.
  3. Defining a Route:

    @app.route('/')
    def home():
        return render_template('index.html')
    • @app.route('/'): home 함수를 트리거하는 URL을 지정한다.
    • def home():: 루트 URL 방문 시 실행되는 함수로, 'index.html' 템플릿을 렌더링한다.

요약

  • render_template: html 템플릿을 렌더링하는 함수
  • jsonify: 데이터를 파이썬 dic 에서 json 형태로 응답을 보내는 함수
  • request: 클라이언트가 보낸 정보를 캡슐화하는 객체(폼 or 쿼리 파라미터)
  • @app.route(url) 이 호출될 때 실행할 함수를 지정할 수 있다.
profile
티스토리 이사 준비 중..

0개의 댓글