Flask #7 json 응답하기, swagger 작성

iwantit·2026년 3월 24일

Flask

목록 보기
7/8

1. Json 으로 응답하기

from flask import Flask
app = Flask(__name__)

@app.route("/api/hello")
def hello():
    return {
        "message": "Hello, Flask!",
        "status": "success"
    }

if __name__ == "__main__":
    app.run(debug=True)
  • Json 또한 key, value 형식이다.

하지만 Flask 공식 문서에서는 jsonify를 권장한다.

# 추가해주기
from flask import Flask, jsonify

# jsonify 사용하는 방법
def hello():
    return jsonify({
    "message": "success"
})

한글로 성공 입력시 아스키로 변환되어 나타난다.

한국어로 그래도 나타내는 방법

app.json.ensure_ascii = False

app = Flask(name) 여기에 붙여준다.

2. swagger 문서 작성하기

pip install flasgger

flasgger은 swagger앱이다.

from flask import Flask, jsonify
from flasgger import Swagger

app = Flask(__name__)
app.json.ensure_ascii = False

Swagger(app)

@app.route("/api/hello")
def hello():
    """
    간단한 Hello API
    ---
    responses:
      200:
        description: 성공 메시지 반환
        examples:
          application/json:
            message: 성공
    """

    return jsonify({
    "message": "성공"
})

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

profile
클라우드/백엔드 엔지니어 지망생

0개의 댓글