ABOUT ME

-

Today
-
Yesterday
-
Total
-
  • REST API
    CS/AWS 2023. 7. 20. 16:28

    - REST API 란

    REST API는 Representational State Transfer의 약자로, 웹 서비스와 클라이언트 간의 통신을 위한 아키텍처 스타일로, 자원을 고유한 URL로 표현하고 HTTP 메서드(GET, POST 등)를 사용하여 해당 자원에 대한 CRUD(Create, Read, Update, Delete) 작업을 수행하는 인터페이스를 제공하는 것이다.

     

    - REST API의 동작 방식

    1. 자원(Resource) 식별: REST API는 모든 자원을 고유한 식별자인 URL로 표현합니다. 예를 들어, 웹 서비스의 사용자 정보에 접근하기 위해 `/users`라는 URL을 사용할 수 있습니다.

    2. HTTP 메서드 사용: HTTP 메서드를 사용하여 해당 자원에 대한 액션을 정의합니다.

       - GET: 자원을 조회(Read)합니다. 즉, 서버에서 데이터를 가져옵니다.
       - POST: 자원을 생성(Create)합니다. 즉, 서버에 새로운 데이터를 추가합니다.
       - PUT: 자원을 수정(Update)합니다. 즉, 서버의 데이터를 업데이트합니다.
       - DELETE: 자원을 삭제(Delete)합니다. 즉, 서버의 데이터를 삭제합니다.
       - 그 외에도 PATCH, HEAD, OPTIONS 등의 다양한 HTTP 메서드가 있습니다.

    3. 상태 없음(Stateless): REST API는 클라이언트와 서버 간의 상태를 저장하지 않습니다. 각각의 요청은 독립적으로 처리되며, 클라이언트가 필요한 모든 정보를 요청에 포함시켜야 합니다.

    4. 데이터 형식: 주로 JSON 혹은 XML 형식의 데이터를 주고 받습니다. 최근에는 JSON이 더 널리 사용되고 있습니다.

    5. 응답 상태 코드: 서버는 요청에 대한 적절한 상태 코드를 반환합니다. 예를 들어, 성공적으로 자원을 조회했다면 200 OK를 반환하고, 자원이 존재하지 않을 경우 404 Not Found를 반환합니다.

    REST API의 위의 특징들을 잘 따르면, 클라이언트와 서버 간의 통신이 효율적이고 확장성 있게 구축할 수 있습니다.

     

    - FastAPI란

     

    FastAPI는 Python으로 작성된 웹 프레임워크로서, 고성능의 RESTful API를 빠르고 쉽게 개발할 수 있도록 지원하는 도구입니다. FastAPI는 Python의 타입 힌트(type hint)를 사용하여 빠르고 정확한 API를 작성할 수 있게 해주며, Pydantic 라이브러리를 통해 데이터 유효성 검사와 직렬화를 자동으로 처리할 수 있습니다.

    FastAPI는 Starlette 및 Pydantic과 함께 구축되어 비동기 처리(Asynchronous)를 지원하므로, 대규모 API 서비스 또는 실시간 처리가 필요한 애플리케이션에 적합합니다. 또한, Python의 표준인 ASGI(Asynchronous Server Gateway Interface) 서버를 사용하여 빠르고 가볍게 작동합니다.

    FastAPI는 간결한 문법과 자동 생성된 API 문서를 제공하여 개발 생산성을 향상시킵니다. Swagger UI 및 ReDoc과 같은 도구를 통해 API 문서를 자동으로 생성하고 시각화할 수 있습니다.

    이러한 특징들로 인해 FastAPI는 Python 개발자들 사이에서 인기가 높아지고 있으며, 빠른 API 개발과 효율적인 성능을 추구하는 프로젝트에서 많이 사용되고 있습니다.

     

    -FAST API 동작 방식

     

    1. 라우팅(Route): FastAPI는 `@app.route()` 데코레이터를 사용하여 URL 경로에 대한 핸들러 함수를 정의합니다. 이러한 핸들러 함수는 클라이언트의 요청에 대한 응답을 반환하는 역할을 합니다.

    2. HTTP 메서드 처리: 핸들러 함수는 클라이언트의 HTTP 요청 메서드(GET, POST, PUT, DELETE 등)에 따라 적절한 기능을 수행합니다. FastAPI는 함수의 이름을 기반으로 해당 함수를 어떤 HTTP 메서드에 매핑해야 하는지 자동으로 결정합니다.

    3. 경로 변수 및 쿼리 매개변수: FastAPI는 URL 경로에서 변수를 추출하는 기능과 쿼리 매개변수를 처리하는 기능을 제공합니다. 예를 들어, `/items/{item_id}`와 같은 경로는 `item_id`라는 변수를 추출하여 핸들러 함수로 전달할 수 있습니다.

    4. 요청 및 응답 모델: FastAPI는 Pydantic 모델을 사용하여 요청 데이터와 응답 데이터의 유효성을 검사하고 직렬화합니다. 이를 통해 요청 데이터의 유효성을 확인하고 적절한 응답을 생성하는 것이 간단하고 안전하게 처리됩니다.

    5. 비동기 지원: FastAPI는 비동기(Asynchronous) 처리를 지원하여 높은 성능과 동시성을 제공합니다. `async def` 키워드를 사용하여 비동기 핸들러 함수를 작성할 수 있으며, Starlette와 함께 ASGI 서버를 사용하여 비동기 요청을 처리합니다.

    6. 자동 생성된 문서: FastAPI는 Swagger UI와 ReDoc과 같은 도구를 통해 자동으로 API 문서를 생성하고 시각화할 수 있습니다. 개발자는 API 엔드포인트, 요청/응답 모델, 쿼리 매개변수 등에 대한 정보를 쉽게 확인할 수 있습니다.

    7. ASGI 서버: FastAPI는 ASGI(Asynchronous Server Gateway Interface)를 지원하는 서버와 함께 사용됩니다. 이를 통해 다양한 ASGI 서버에서 FastAPI 애플리케이션을 호스팅하고 운영할 수 있습니다.

    FastAPI는 이러한 기능들로 개발자에게 빠른 API 개발과 효율적인 성능을 제공하며, 쉽게 확장 가능한 웹 애플리케이션을 만들 수 있도록 도와줍니다.

     

    - FASTAPI 서버 종류

    FastAPI 자체는 웹 애플리케이션을 실행시키는 서버가 아닙니다.
    FastAPI로 개발한 애플리케이션을 실행시키기 위해서는 ASGI(Asynchronous Server Gateway Interface) 호환 서버를 사용해야 합니다. ASGI 서버는 FastAPI의 비동기 처리를 지원하며, FastAPI 애플리케이션을 호스팅하고 운영하는 역할을 담당합니다.

    FastAPI 애플리케이션을 실행시키기 위해 가장 일반적으로 사용되는 ASGI 서버는 다음과 같습니다:

    1. Uvicorn: FastAPI와 같이 개발된 Starlette 프레임워크와 호환되는 ASGI 서버입니다. 가장 널리 사용되는 방법 중 하나입니다.

    2. Hypercorn: Python 3.7 이상에서 사용할 수 있는 ASGI 서버로서, Uvicorn과 유사한 기능을 제공합니다.

    3. Daphne: Django에서도 사용되는 ASGI 서버로, FastAPI 애플리케이션을 실행시키는데에도 사용할 수 있습니다.

    이 중에서 Uvicorn을 가장 많이 사용하며, FastAPI의 공식 문서에서도 Uvicorn을 사용하여 FastAPI 애플리케이션을 실행시키는 방법을 소개하고 있습니다. 따라서 FastAPI 애플리케이션을 개발하고 실행시키기 위해서는 FastAPI와 Uvicorn을 함께 사용하게 됩니다.

Designed by Tistory.