Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Denne side beskriver de anvendte principper for brugen af danske sprog i STARs udstilling af webservices. Ydermere forholder siden sig til, hvor og hvornår udviklere kodemæssigt kan benytte sig af det engelske sprog og engelske termer.

...

  • Servicesnitflader til REST services kodes på dansk i alle forretningsdomæner (siloer). Dette for at understøtte STARs princip om dansk navngivning i servicesnitflader. Dette princip er ensbetydende med, at alle servicesnitfalder i form af Swagger-kontrakter og indholdet i Swagger-kontrakter udstilles på dansk. Derfor skal nedenstående elementer til servicesnitflader kodes på dansk:

    • navne på metoder, dog tillades brugen af Get, Post og Put, som en del af metodenavnet, når metodenavnet ikke indgår i servicesnitflader.

    • navne på parametre, som indgår i servicesnitfalder.

    • Data Transfer Objects (DTO’er) til Requests og Responses i servicesnitflader.

    • indhold i HTTP templates.

    • navne såvel som Enum værdier til kodelister.

    • fejlkodetekster.

  • Forretningslogik (forretningslaget), der ligger under servicesnitflader kodes på engelsk. Dette er gældende for:

    • CQS Features med deres tilhørende Requests og Responses.

    • Andet forretningslogik i form af valideringsmetoder, hjælpeklasser m.m.

  • Domæne objekter kodes på engelsk dog med undtagelse af kodelister, hvor navne såvel som Enum værdier kodes på dansk, da de vil indgå i servicesnitflader.

  • Data Access i form af Storage klasser, Stored Procedures, navne på tabeller samt navne på felter kodes på engelsk. Dog angives tabel- og feltbeskrivelser på dansk af hensyn til SUP samt aflevering til Statens Arkiver.

  • DENNE SKAL AFKLARES: Navne samt Properties på Events, der publiceres til og aftages fra Event Brokeren, kodes på dansk (eller fremadrettet på engelsk?)

  • Sikkerhedsheaders samt lignende standardelementer, såsom WSRM base-modellem kodes på engelsk.

  • I både SOAP og REST servicesnitflader erstattes æ, ø og å med respektive ae, oe og aa for en sikkerheds skyld indtil andet er aftalt med aftagere.

  • Der anvendes ikke æ, ø eller å i kompileret kode.

...

Samling er erstatningen for Collection (som har været rigtigt meget brugt i DFDG), men kan ofte erstattes af flertal, fx kunne kan man let bruge Persongruppemarkeringer isf. -Samling her nedenfor ved (4)PersongruppeSamling.

Vi tilstræber flertalsformen, men af og til bruger Samling når vi mener at det er den bedste forretningsmæssige ordform (hele målet med dansk er jo at forretningen skal kunne forstå og genkende sine forretningstermer i vores services).

Ved (5) og (6) rettes der til Indkaldelser, og Indkaldelse jf. ovenstående principper. 

...

Eksempel på begge:

Element

Forekomst

Møde

1

- Mødested

1

- MødeStarttidspunkt

1

- MødeSluttidspunkt

1

- Mødedeltagere

1

- - Mødedeltager

0 - *

- - - Navn

1

- - - Rolle

1

...