developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud

/core/query-keys-camel-case

Een query key mag alleen letters en cijfers bevatten, waarbij elk woord na het eerste met een hoofdletter begint. Het eerste teken is een kleine letter en mag geen cijfer zijn. Dat is lowerCamelCase: ?aantalPerPagina=20, niet ?aantal-per-pagina=20 of ?AantalPerPagina=20.

Let op het verschil met het pad: een pad is kebab-case, een query key is lowerCamelCase. Dezelfde URI gebruikt dus beide conventies.

Uitdrukken in OAS​

/openapi.yaml
openapi: 3.1.0
paths:
/open-source-projecten: # kebab-case in het pad
get:
parameters:
- name: aantalPerPagina # goed, lowerCamelCase
in: query
- name: aantal-per-pagina # fout, kebab-case hoort niet in een query key
in: query
- name: AantalPerPagina # fout, UpperCamelCase
in: query
- name: 2eSorteerveld # fout, begint met een cijfer
in: query