Python용 Cloud Endpoints 프레임워크를 사용하여 API 만들기

API는 외부 클라이언트에 액세스할 수 있는 원격 메소드를 제공하는 RPC(원격 절차 호출) 서비스입니다. 각 백엔드 API는 ProtoRPC remote.Service 클래스를 서브클래싱하는 RPC 서비스 클래스와 하나 이상의 메서드로 구성됩니다. 메서드를 정의할 때는 해당 메서드로 들어오는 요청과 해당 메서드에서 반환되는 응답에 사용되는 Message 클래스도 정의해야 합니다. Message 클래스는 매핑 기능을 수행하므로 들어오는 데이터를 추출하여 서비스 메서드나 나가는 응답에 적절하게 제공할 수 있습니다.

요청에 경로 또는 쿼리 문자열 인수가 있으면 단순 Message 클래스 대신 ResourceContainer 클래스를 매핑에 사용합니다.

마지막으로, API 서비스 클래스와 클래스 메서드를 데코레이션하고 요청 및 응답에 사용되는 Message 클래스를 정의해야 합니다.

API 만들기

다음 절차에서는 코드를 데코레이션하여 단일 클래스로 구현된 API를 만드는 방법을 보여줍니다. 다중 클래스가 있는 경우 여러 클래스로 구현된 API 만들기를 참조하세요. 사용 가능한 모든 데코레이터에 대한 자세한 내용은 데코레이터를 참조하세요.

API를 만들려면 다음 안내를 따르세요.

  1. 다음 필수 가져오기를 추가합니다.

    import endpoints
    from endpoints import message_types
    from endpoints import messages
    from endpoints import remote
  2. remote.Service의 서브클래스를 정의하고 이를 @endpoints.api로 데코레이션합니다.

    @endpoints.api(name='echo', version='v1')
    class EchoApi(remote.Service):

    API 이름과 서비스 클래스 이름이 동일할 필요는 없습니다. 버전 번호는 API 버전에 적용됩니다. 입력하는 값이 API로 연결되는 URL 경로의 일부가 됩니다. 버전에 대한 자세한 내용은 API 버전 관리를 참조하세요.

  3. 메서드가 요청에서 받아야 하는 데이터와 반환할 데이터를 결정하고 요청 본문과 응답 본문에 사용되는 Message 클래스를 만듭니다.

    class EchoRequest(messages.Message):
        message = messages.StringField(1)
    
    class EchoResponse(messages.Message):
        """A proto Message that contains a simple string field."""
        message = messages.StringField(1)
    
    ECHO_RESOURCE = endpoints.ResourceContainer(
        EchoRequest,
        n=messages.IntegerField(2, default=1))

    GET 요청에서처럼 요청 본문에 인수가 나타나지 않는 경우에는 요청에 사용되는 Message 클래스를 생략하고 단순히 message_types.VoidMessage 값을 사용해도 됩니다.

    요청에 경로 또는 쿼리 문자열 인수가 있으면 Message 클래스를 적절한 ResourceContainer로 바꿉니다.

    Message 클래스 작성 및 사용에 대한 자세한 내용은 Google 프로토콜 RPC 응답 및 요청 Message 클래스에 관한 문서를 참조하세요.

  4. API에 대한 메서드를 만들고 @endpoints.method로 데코레이션합니다.

    @endpoints.method(
            # This method takes a ResourceContainer defined above.
            ECHO_RESOURCE,
            # This method returns an Echo message.
            EchoResponse,
            path='echo',
            http_method='POST',
            name='echo')
        def echo(self, request):

    요청에 경로 또는 쿼리 문자열 데이터가 있으면 요청 메시지 유형을 적절한 ResourceContainer로 바꿉니다.

  5. 웹 서버 만들기의 설명에 따라 API를 제공할 코드를 추가합니다.

다음 단계