GovernIB / projectebase

Projecte Base - JBoss 7.2 EAP & Open JDK 11
4 stars 0 forks source link

Afegir plantilla per implementar la reutilització de dades dins d'un projecte Swagger #153

Open acuevas-dgtic opened 7 months ago

acuevas-dgtic commented 7 months ago

En el cas que un servei REST orientat a dades obertes que retorni una gran quantitat de dades es recomana paginar la sortida de les dades. En aquest cas, la resposta hauria d'incloure 9 camps que informin d’aquesta paginació:

    1 Page-size: nombre d’elements que es sol·liciten per pàgina.
    2 Total-count: nombre total d’elements.
    3 Items-returned: nombre d’elements retornats en una pàgina.
    4 Page: número de la pàgina actual.
    5 Next-url: URL completa per accedir a la pàgina següent.
    6 Total-pages: nombre total de pàgines.
    7 Date-download: data de la descàrrega (en format ISO8601: 2022-07-26T12:58:55+02:00).
    8 Name: nom del conjunt de dades (exemple, allotjaments turístics).
    9 Data: llista d’elements (items) retornats.

image

Els camps Page-size i Page hauran de ser paràmetres d’entrada opcionals de la consulta. (exemple d'URL: https://intranet.caib.es/enviafibapi/interna/public/peticions/consultapeticions?page-size=100&page=2

Quan s’arribi a la darrera pàgina, el camp next-url haurà de contenir la mateixa url de la consulta actual ja que no hi haurà més pàgines a consultar.

Exemple de resposta: image

S'hauria d'afegir un exemple d'estructura Java per implementar la reutilització de dades (paginat i sense paginació), similar al publicat en https://github.com/GovernIB/genapp/tree/genapp-2.0/demo/generat/demogenapp-api-interna/src/main/java/org/fundaciobit/demogenapp/api/interna/all/exemplereutilitzacio