Creazione dell'API utilizzando Cloud Endpoints Frameworks per Python

Un'API è un servizio di chiamata di procedura remota (RPC) che fornisce metodi remoti accessibili a client esterni. Ogni API di backend è costituita da una classe di servizio RPC che è una sottoclasse della classe ProtoRPC remote.Service e da uno o più metodi. Quando definisci un metodo, devi anche definire le classi Message per le richieste in arrivo e le risposte restituite dal metodo. Una classe Message esegue una funzione di mappatura in modo che i dati in entrata possano essere estrapolati e forniti correttamente al metodo del servizio o alla risposta in uscita.

Se una richiesta ha argomenti path o stringa di query, utilizza una classe ResourceContainer per la mappatura anziché una semplice classe Message.

Infine, devi decorare la classe di servizio API e i metodi della classe e devi definire le classi Message per le richieste e le risposte.

Creazione dell'API

La procedura seguente mostra come decorare il codice per creare un'API implementata in una singola classe. Se hai un'API con più classi, consulta Creazione di un'API implementata con più classi. Per informazioni dettagliate su tutti i decoratori disponibili, consulta Decoratori.

Per creare un'API:

  1. Aggiungi le seguenti importazioni obbligatorie:

    import endpoints
from endpoints import message_types
from endpoints import messages
from endpoints import remote

  2. Definisci una sottoclasse di remote.Service e decorala con @endpoints.api:

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

    Tieni presente che il nome dell'API e il nome della classe di servizio non devono necessariamente essere uguali. Il numero di versione si applica alla versione dell'API. Il valore inserito fa parte del percorso nell'URL della tua API. Per ulteriori informazioni sulle versioni, consulta Gestire il controllo delle versioni dell'API.

  3. Determina i dati che il metodo si aspetta dalla richiesta e quali dati vengono restituito e crea una classe Message per il corpo della richiesta e il corpo della risposta:

    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)
)

    Tieni presente che se nel corpo della richiesta non vengono visualizzati argomenti, ad esempio in una richiesta GET, puoi omettere la classe Message per la richiesta e utilizzare semplicemente il valore message_types.VoidMessage.

    Se la richiesta contiene argomenti di stringa di query o percorso, sostituisci la classe Message con un ResourceContainer appropriato.

    Per informazioni complete sulla formazione e sull'utilizzo delle classi Message, consulta la documentazione per le classi Message di richiesta e risposta del protocollo RPC di Google.

  4. Crea il metodo per la tua API e decoralo con @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):

    Se la richiesta contiene dati relativi a path o stringa di query, sostituisci il tipo di messaggio di richiesta con un valore ResourceContainer appropriato.

  5. Aggiungi il codice per pubblicare l'API, come descritto in Creazione di un server web.

Passaggi successivi