Skip to content
This repository was archived by the owner on Jan 25, 2022. It is now read-only.

Comunicaciones

Alejandro González Hevia edited this page Feb 23, 2021 · 2 revisions

PostsService

1.- Listado de posts con paginación + filtros

GET: /api/posts

Query params:

  • Limit (int): Numero de resultados por consulta (default=10)
  • Offset (int): A partir de qué post se devuelve resultado (default=0)
  • User (long): ID del usuario del que queremos obtener los posts
  • Language (string): String del lenguaje de los posts a obtener

Resultado válido:

{
	“links”: {
		“self”: “url_actual”,
		“first”: “url_primeros_elementos”,
		“prev”: “url_pagina_anterior”,
		“next”: “url_pagina_siguiente”,
		“last”: “url_ultima_pagina”
	},
	“count”: 10,
	“total”: 500,
	“posts”: [
	{
		id: 1,
		content: “”,
		language: “en”,
		topics: [
			“topic_a”, “other topic”, “sample”
		],
		is_offensive: false,
		likes: 150,
		user: <id_usuario_autor>
	},
	…
	{
		id: 10,
		…
	}
	]
}

2.- Obtener datos de un post

GET: /api/posts/

Resultado válido:

{
	id: 1,
	content: “”,
	language: “en”,
	topics: [
		“topic_a”, “other topic”, “sample”
	],
	is_offensive: false,
	likes: 150,
	user: <id_usuario_autor>
}

3.- Crear un nuevo post

POST: /api/posts

Los campos de idioma, id, topics, is_offensive y likes los crea automáticamente el servicio, por lo que no hace falta introducir mucha info aquí.

Ejemplo de entrada (body):

{		
	content: “”,
	user: <id_usuario_autor>
}

Resultado válido:

202 - Created

4.- Eliminar un post existente

DELETE: /api/posts/

Resultado válido:

Código deleted


StatisticsService

HABLAR CON TODOS En principio soap internamente + luego rest con lo del readme?


UsersService


MessagesService


TranslationService

1.- Realizar una traducción

POST: /api/translation

Ejemplo de entrada (body)

{
	“from”: “<codigo-idioma>”,
	“to”: “<codigo-idioma>”,
	“text”: “texto a traducir”
}

Respuesta válida

{
	“from”: “<codigo-idioma>”,
	“to”: “<codigo-idioma>”,
	“original”: “texto original”,
	“translation”: “texto traducido”
}

Respuesta inválida

429 - Too Many Requests: Se nos acabó la plata

TextToSpeechService

1.- Convertir texto a audio

POST: /api/tts

Ejemplo de entrada (body)

{
	“language”: “<codigo-idioma>”,
	“text”: “texto a ttsear”
}

Respuesta válida

{
	“language”: “”
	“text”: “”,
	“result” “<audio codificado de alguna manera. Depende de la api…>”
}

Respuesta inválida

429 - Too Many Requests Se nos acabó la plata

Clone this wiki locally