You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 30, 2021. It is now read-only.
- query parameters : **page**= en **pagesize**= en **pagingStrategy**=
175
+
- query parameters : **page**= en **pagesize**= en **paging-strategy**=
174
176
- optioneel mee te geven door clients (bij ontbreken worden de default waardes gebruikt)
175
177
- 1-based (1e pagina is pagina 1)
176
178
- Response volgens HAL specificatie
@@ -180,7 +182,7 @@ Swagger v2.0, JSON
180
182
-\_embedded
181
183
-\_page
182
184
- voorbeelden
183
-
- beide `pagingStrategy` waardes (`noCount` en `withCount`) moeten ondersteund worden
185
+
- beide `paging-strategy` waardes (`noCount` en `withCount`) moeten ondersteund worden
184
186
185
187
### Event resources
186
188
@@ -823,17 +825,17 @@ Paginatie informatie wordt **steeds** terug gegeven bij het ophalen van collecti
823
825
824
826
Vanuit consumer standpunt is het noodzakelijk dat volgende informatie in de response wordt gegeven om voldoende informatie te bekomen rond de pagina's:
|| Totaal aantal elementen | Afhankelijk van paging-strategy|
838
+
|| Totaal aantal pagina's | Afhankelijk van paging-strategy|
837
839
838
840
839
841
@@ -843,11 +845,11 @@ Daarom kiezen we met onze API requirements voor een oplossing die 2 strategieën
843
845
- een snellere opvraging zonder verplichte 'count'
844
846
- een potentieel tragere opvraging tengevolge een impliciet 'count'-mechanisme
845
847
846
-
De client toepassing kiest welke strategie wordt toegepast dmv van een (optionele) query parameter : **`pagingStrategy`** (zie verder).
848
+
De client toepassing kiest welke strategie wordt toegepast dmv van een (optionele) query parameter : **`paging-strategy`** (zie verder).
847
849
848
850
### Paginatie query parameters
849
851
850
-
Het ophalen van een bepaalde pagina zelf dient te gebeuren door middel van de **`page`** en **`pagesize`** query parameters (behalve voor de `last` link bij `pagingStrategy=noCount`, zie verder).
852
+
Het ophalen van een bepaalde pagina zelf dient te gebeuren door middel van de **`page`** en **`pagesize`** query parameters (behalve voor de `last` link bij `paging-strategy=noCount`, zie verder).
851
853
```prettyprint
852
854
/partners?page=1&pagesize=10
853
855
```
@@ -859,7 +861,7 @@ De paginatie query parameters zijn **optioneel**. Dat maakt dat wanneer deze **n
859
861
- Een beperkte set van resources wordt teruggegeven bij het bevragen van collections op basis van een default page size die voor elke API wordt bepaald.
860
862
- Steeds de eerste pagina wordt terug gegeven.
861
863
862
-
Om de paging strategie mee te geven, gebruikt de consumer de optionele parameter **`pagingStrategy`**. Deze heeft 2 mogelijke waardes :
864
+
Om de paging strategie mee te geven, gebruikt de consumer de optionele parameter **`paging-strategy`**. Deze heeft 2 mogelijke waardes :
863
865
- withCount (default als de query parameter niet wordt meegegeven)
864
866
- noCount
865
867
@@ -940,9 +942,9 @@ Dit resulteert in volgende structuur.
940
942
```
941
943
942
944
Het **\_page** reserved keyword vormt geen onderdeel van de HAL specificatie, maar is extra metadata die in de response message komt om
943
-
een indicatie te krijgen van de huidige paginanummer, aantal elementen per pagina, het totaal aantal pagina's en het totaal aantal elementen en vereenvoudigt de bewerkingen langs consumer kant om deze informatie te bekomen. Bij **`pagingStrategy=noCount`** worden `totalElements` en `totalPages` weg gelaten.
945
+
een indicatie te krijgen van de huidige paginanummer, aantal elementen per pagina, het totaal aantal pagina's en het totaal aantal elementen en vereenvoudigt de bewerkingen langs consumer kant om deze informatie te bekomen. Bij **`paging-strategy=noCount`** worden `totalElements` en `totalPages` weg gelaten.
944
946
945
-
Voorbeeld bij `pagingStrategy=withCount` :
947
+
Voorbeeld bij `paging-strategy=withCount` :
946
948
```json
947
949
{
948
950
"_page": {
@@ -954,7 +956,7 @@ Voorbeeld bij `pagingStrategy=withCount` :
954
956
}
955
957
```
956
958
957
-
Voorbeeld bij `pagingStrategy=noCount` :
959
+
Voorbeeld bij `paging-strategy=noCount` :
958
960
```json
959
961
{
960
962
"_page": {
@@ -999,14 +1001,14 @@ Alle aspecten van paginatie samenvoegend geeft dit volgende response wrapper mes
999
1001
}
1000
1002
```
1001
1003
1002
-
Zoals reeds vermeld vallen `totalElements` en `totalPages` weg bij `pagingStrategy=noCount`.
1004
+
Zoals reeds vermeld vallen `totalElements` en `totalPages` weg bij `paging-strategy=noCount`.
In de **last** link wordt gebruik gemaakt van **page=last** ipv het exacte paginanummer om te vermijden dat een count moet uitgevoerd worden bij het ophalen van de lijst. Dit houdt wel impliciet in **dat de API deze waarde (=last) ook verplicht moet ondersteunen**. Pas wanneer deze wordt gebruikt zal de API een count uitvoeren om op dat moment de laatste pagina te berekenen en terug te geven.
1081
1083
1082
-
Een API moet altijd beide `pagingStrategy` methodes ondersteunen.
1084
+
Een API moet altijd beide `paging-strategy` methodes ondersteunen.
1083
1085
1084
1086
**Bij het ophalen van een collection zonder specificatie van query parameters dient paginatie informatie altijd aanwezig te zijn in de
1085
1087
response message**, gebruik makend van de `withCount` paginatie strategie.
0 commit comments