Kus ja kuidas peaks sisendandmete valideerimise reeglid olema kirjas?

Sisendandmete valideerimise reeglid peavad olema kirjeldatud API spetsifikatsioonis, näiteks OpenAPI (Swagger) või teises dokumentatsiooniformaadis. See võimaldab klientidel ja arendajatel mõista, millised andmed on oodatud ja millised piirangud kehtivad.

Kirjeldus hõlmab:

• Andmetüüpe (string, integer, boolean jne).
• Väli kohustuslik või mitte.
• Formaatide (näiteks email, kuupäev).
• Väärtuste vahemikke või pikkusi.
• Täiendavaid reegleid, näiteks regulaaravaldisi.

Serveris rakendatakse neid reegleid sisendkäsu valideerimisega, mis tagab andmete turvalisuse ja õigsuse.

OpenAPI näide kirjelduse kohta:

parameters:
  - name: email
    in: query
    required: true
    schema:
      type: string
      format: email