웹 백엔드 - API의 구조, API 만들기

API의구조

1.Resource

2.HTTP Method

3.Message

 

API는 자원 접근 시 URI로 하게된다

GET:/board/{board_id}

 

Message

Header -Body에 어떠한 정보가 담겨 있는지에 대한 정보가 있는 공간

Body – 전달하는 정보가 담겨 있는 공간

 

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

# flask_restful 을 이용하면 더 쉽게 REST API를 만들 수 있다

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


class Hello(Resource): # Resource를 상속받은 class
    def get(self): ## @app.route('/', methods=['GET']) 랑 같은
        # msg 변수에 dictionary type으로 메세지를 입력
        msg = None
        return jsonify(status = "success", result = msg)

api.add_resource(Hello, '/') # class를 인자로 받는다

 

API

개발한API를브라우저에서테스트하는것은매우까다롭고어려운일

그렇기때문에Postman이라는툴을사용하여쉽게API를테스트할것입니다.

parser.add_argument("id")로 넣어준 걸 딕셔너리로 바꿔주는 게 parser.parse_args() 

 

add_resource는 API를 등록하는 과정

add_argument는 파라미터를 등록하는 과정