ProntoGram

Panoramica

Dentro la rete Docker acmesky-network, tutti gli URI sono relativi a http://prontogram_backend:8080.
Da fuori Docker, la porta per raggiungere il servizio è 5001.

Risorsa	Descrizione	Risorsa per
POST /messages	Permette di inviare il messaggio a ProntoGram per essere inoltrato all'utente specificato.	ACMESky

Richieste

POST /messages

Permette di inviare il messaggio a ProntoGram per essere inoltrato all'utente specificato.

Parametri

Nome	Tipo
Message	Message

Tipo di ritorno

200: -

Header della richiesta

Content-Type: application/json
Accept: application/json

Modelli

Message

Nome	Tipo
sender	String
receiver	String
body	String
send_time	DateTime

Interfaccia OpenAPI

Nel seguente blocco (cliccare sulla barra con su scritto "OpenAPI" in basso per aprirlo) è possibile visualizzare l'interfaccia OpenAPI che descrive il funzionamento delle API fornite da ProntoGram.

OpenAPI

openapi: 3.0.0
info:
  title: ProntoGram
  version: '1.0'
  description: Interface that models the operations available for ProntoGram in ACMESky.
servers:
  - url: 'http://prontogram_backend:8080'
    description: Inside the Docker network
  - url: 'http://chosen_url:5001'
    description: Outside the Docker network (chosen_url is a placeholder)
paths:
  /messages:
    post:
      summary: sendMessage
      operationId: sendMessage
      responses:
        '200':
          description: OK
      description: |-
        Sends the message to ProntoGram for being dispatched to the actual user.
        API for: ACMESky
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Message'
components:
  schemas:
    Message:
      title: Message
      type: object
      properties:
        sender:
          type: string
          minLength: 1
        receiver:
          type: string
          minLength: 1
        body:
          type: string
          minLength: 1
        send_time:
          type: string
          format: date-time
      required:
        - sender
        - receiver
        - body

Torna a Servizi web.