RESTful 디자인 & 라우트: 프로처럼 API 정리하기

Source: Dev.to

REST란 무엇인가?

REST (Representational State Transfer) 은 API 설계를 위한 규칙 집합입니다.

나쁜 API 예시

• /getUser
• /fetchAllPosts
• /doLogin

좋은 REST API 예시

• /users
• /posts
• /auth/login

깨끗하고, 예측 가능하며, 조직적이다.

구조화된 라우트 (GDGoC Bowen 30일 챌린지 Day 2)

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def home():
    return {
        "msg": "Welcome to my API",
        "version": "1.0",
        "track": "Backend Development"
    }

@app.get("/about")
def about():
    return {
        "name": "Fiyinfoluwa Ojo",
        "challenge": "GDGoC Bowen 30 Day Challenge",
        "track": "Backend Development",
        "day": 2
    }

@app.get("/status")
def status():
    return {
        "status": "up",
        "message": "Server is running smoothly"
    }

실시간 응답

모든 운영 API는 헬스 체크 엔드포인트를 가지고 있습니다.

Day 2 완료. 남은 28일. 🔥