Fast API Tutorial(1): introduction

api 공부 기록

환경 설정

• requirements.txt 파일 작성

fastapi
uvicorn[standard]

requirements.txt

실습

• "message":"hellow world"
• 터미널에서 호출 방법: univocorn main:app

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
return {"message":"hello world"}

main:app의 의미

- main.py에서의 main

- app = FatAPI(), @app에서의 app

만약 main.py를 hello.py로 변경 & app명칭을 world로 변경하면?

변경된 예시

uvicorn hello:world처럼 입력하면 됨

다시 돌아와서,

uvicorn main:app을 하게되면, 기본 port로 8000이 잡히는데,

uvicorn main:app --port 5000 등 포트번호를 설정할 수 있음

--reload를 하면 코드 변경 후 저장했을 때, 자동으로 reload 하게된다

post 추가 후, 저장하면, 자동으로 reloading 되는 모습

http://127.0.0.1:8000에 /docs를 추가하면 swagger docs를 확인할 수 있다

postman과 같은 앱 대신 쉽게 확인할 수 있을 것 같다.

아까 했던 --reload 기능을 확인하기 위해, put을 추가하여 저장 후, 다시 docs를 확인해보기로 한다.

@app.put("/") 추가

docs 초기화면

화살표를 펼쳐, 자세한 사항을 확인해본다.

대표로 get만 확인해본다.

get

execute 실행 시, 설정한 response를 잘 받아오는 것을 확인가능

get에서 설명을 달거나, 함수명을 바꾸면 docs에서 확인가능

get의 함수명칭이 바뀐 것과, 설명이 추가된 것을 확인할 수 있다

구글에 swagger docs를 검색해 공식 문서를 확인해보자

https://swagger.io/docs/

Swagger Documentation

 

전체 코드

from fastapi import FastAPI

app = FastAPI()

@app.get("/", description='this is our first roote')

async def base_get_roote():

    return {"message":"hello world"}

@app.post("/")

async def post():

    return {"message":"hello from the post roote"}

@app.put("/")

async def put():

    return {"message":"hello from the put roote"}