Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conventie naamgeving voor API's #290

Closed
ehotting opened this issue Dec 5, 2018 · 3 comments
Closed

Conventie naamgeving voor API's #290

ehotting opened this issue Dec 5, 2018 · 3 comments

Comments

@ehotting
Copy link
Collaborator

ehotting commented Dec 5, 2018

In de API strategie staat summier iets over de naamgeving van resources, API-07 en API-08 *).

Conventies voor naamgeving van API's zijn ook nuttig. De eerste vragen hierover dienen zich aan. Is er verschil tussen CRUD data API's en API's die business rules ontsluiten? Hoe zorgen we voor een zekere uniciteit in naamgeving?

*) API-07 Definitie van het koppelvlak is in het Nederlands tenzij er sprake is van een officieel Engelstalig begrippenkader
API-08 Resource namen zijn zelfstandige naamwoorden in het meervoud

@GeertJohan
Copy link

Google api design docs bevatten een aantal nuttige punten:
Service names: https://cloud.google.com/apis/design/naming_convention#service_names
Interface names: https://cloud.google.com/apis/design/naming_convention#interface_names

@jasperroes
Copy link
Collaborator

Voorstel werkgroep: in design rules opnemen dat over API naamgeving is niets over afgesproken (inclusief API principe). We verwijzen mogelijk wel naar bestaande documenten voor nuttig advies als je zelf niet iets logisch kunt verzinnen.

@jasperroes
Copy link
Collaborator

Verwerkt in design rules hoofdstuk, pull request aangemaakt om te mergen.

@fterpstra fterpstra transferred this issue from Geonovum/KP-APIs Sep 4, 2020
@jasperroes jasperroes transferred this issue from Logius-standaarden/API-Design-Rules Nov 25, 2020
@jasperroes jasperroes transferred this issue from another repository Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants