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
Copy file name to clipboardExpand all lines: developpeur.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Celles-ci doivent permette :
25
25
* Principes DRY, KISS, YAGNI, SOC, ...
26
26
* Nommage évocateur, méthodes courtes, ...
27
27
28
-
## Profiter des apports des outils Git et GitLab/GitHub
28
+
## Profiter des apports des outils Git et GitLab/GitHub
29
29
30
30
* Favoriser le mode d'authentification par clef SSH.
31
31
* Favoriser l’utilisation des feature branch et des _Merge/Pull Request_ et pousser régulièrement vos modifications pour éviter de perdre votre travail en cas de crash.
@@ -44,7 +44,7 @@ Celles-ci doivent permette :
44
44
* Pratique des _Merge/Pull Request_.
45
45
* Pratique des revues de code collectives.
46
46
47
-
## "Write all things"
47
+
## "Write all things"
48
48
49
49
* Il est important de pouvoir tout noter, tracer rapidement, dans l'instant pour ne rien oublier et de pouvoir y revenir plus tard en utilisant par exemples des outils comme Trello, Evernote, TodoList, ....
50
50
* Il faut également documenter tous les choix d'architecture ou d'implémentation détaillant les contraintes et/ou les impératifs de chaque situation.
@@ -62,14 +62,14 @@ Celles-ci doivent permette :
62
62
* Partager avec les communautés des développeurs.
63
63
* Documenter / capitaliser.
64
64
65
-
## Élargir son spectre et prendre du recul.
65
+
## Élargir son spectre et prendre du recul
66
66
67
67
* Essayer d'avoir une vision globale en ne se limitant pas à son besoin ou son projet.
68
68
* Se renseigner si une solution n'existe pas déjà ailleurs ou de manière globale.
69
69
* Demander l'avis, voire la validation, des équipes support et d'architecture avant de partir sur une solution technique.
70
70
* Ne pas aller tout le temps sur Internet si une solution interne existe (repo maven ou npm, dockerhub, outillage, ...).
71
71
72
-
## Participer à des événements ou conférences.
72
+
## Participer à des événements ou conférences
73
73
74
74
* Pratiquer des Coding Dojos avec d'autres développeurs.
75
75
* Suivre l'actualité et participer aux différentes communautés.
Copy file name to clipboardExpand all lines: rest-api.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
***PUT** est utilisé pour mettre à jour une instance avec l'intégralité des données.
8
8
***PUT** est utilisé pour créer une nouvelle instance **si l'ID est fourni par le client** (ce qui est rare).
9
9
***PATCH** est utilisé pour mettre à jour une instance avec des données partielles.
10
-
***DELETE** est utilisé pour supprimer un élement, on retournera généralement un statut 204 (_No Content_).
10
+
***DELETE** est utilisé pour supprimer un élément, on retournera généralement un statut 204 (_No Content_).
11
11
12
12
## Règle 2 : Utilisation correcte des status HTTP
13
13
@@ -36,7 +36,7 @@
36
36
* Pour certains cas **à la marge** on pourra exposer des opérations ou des services, on utilisera alors le verbe http POST et on terminera l'URI par un verbe (`orders/128/print`).
37
37
* Utiliser le pluriel pour identifier les ressources : `orders`, `orders/128`, `users`, `users/256`, ...
38
38
* Standardiser le nommage et ne pas mélanger les styles : `PascalCase`, `camelCase`, `snake_case`, `spinal-case`, `UPPERCASE`, `lowercase`, en choisir un et s'y tenir sur toute l'API.
39
-
* Pour trier, filtrer ou affiner on utilisera les paramètres de requêtes : `/orders?page=2`, `/orders?state=paied``/orders?sortBy=name`.
39
+
* Pour trier, filtrer ou affiner on utilisera les paramètres de requêtes : `/orders?page=2`, `/orders?state=payed``/orders?sortBy=name`.
40
40
41
41
## Règle 4 : Assurer la sécurité
42
42
@@ -63,7 +63,7 @@
63
63
64
64
* Ne pas exposer directement les entités JPA :
65
65
* Il existerait un couplage fort entre l'API et le modèle sous-jacent.
66
-
*Celà complexifierait la gestion des versions.
66
+
*Cela complexifierait la gestion des versions.
67
67
* Les 2 modèles pourraient pas évoluer séparément : renommage, ajout/suppression, ...
68
68
* Les entités pourraient être polluer d'annotations qui ne les concernent pas (sérialisation JSON par exemple).
69
69
* Les associations décrites dans les entités n'ont pas à être exposées directement.
0 commit comments