Estructura del objeto para el cual el servicio esta enfocado (normalmente algun tipo de representación de la entidad, ya sea simple, detallada, o ambas).
Por servicio:
Método (GET, POST, PUT, DELETE) (ya lo tienen)
URL (ya lo tienen)
Acción: descripción de que hace el servicio (ya lo tienen)
Parámetros: que parámetros deben ir con la petición (esta parcialmente especificado)
Cuerpo: que va en el body de la petición, por ejemplo cuáles son los atributos de la instancia que va a ser creada (falta)
Retorno efecto de la ejecución del servicio (falta)
Por otro lado, si un servicio no va a ser usado, es probable que no sea necesario considerarlo dentro del API (y por tanto tampoco sea necesario implementarlo).
SarkFox
commented
7 years ago
En general para el API debería de documentarse:
Por otro lado, si un servicio no va a ser usado, es probable que no sea necesario considerarlo dentro del API (y por tanto tampoco sea necesario implementarlo).