Merge pull request #26 from dnum-mi/dev

update doctrine api

_data/metadata.js

@@ -1,6 +1,6 @@
 module.exports = {
     title: "Cadre de cohérence Technique (version Bêta)",
-    url: "https://cct-mi.interieur.gouv.fr/",
+    url: "https://cct-mi.interieur.rie.gouv.fr/",
     newsletter: [
         {
             url: "",

_includes/templates/footer.njk

@@ -42,7 +42,7 @@
           <a class="fr-footer__bottom-link" href="/fr/donnees-personnelles/">{{ "personal_data" | i18n }}</a>
         </li>
         <li class="fr-footer__bottom-item">
-          <a class="fr-footer__bottom-link fr-icon-pencil-line fr-link--icon-left" href="{{ metadata.repository_url }}/blob/main/{{ page.inputPath }}">{{ "edit_this_page" | i18n }}</a>
+          <a class="fr-footer__bottom-link fr-icon-pencil-line fr-link--icon-left" href="{{ metadata.repository_url }}/blob/dev/{{ page.inputPath }}">{{ "edit_this_page" | i18n }}</a>
         </li>
         {# <li class="fr-footer__bottom-item">
           <a class="fr-footer__bottom-link" href="#">Gestion des cookies</a>

content/fr/4-environnement-numerique-de-travail/introduction.md

@@ -4,7 +4,7 @@ layout: layouts/page_date_readtime.njk
 showBreadcrumb: true
 date: Last Modified
 eleventyNavigation:
-  key: introduction
+  key: Introduction
   parent: Environnement Numérique de Travail
   order: 1
 ---

content/fr/5-socle-d-architecture/2-donnees-et-api/0-introduction.md

@@ -13,7 +13,7 @@ eleventyNavigation:
 
 Toute application offre des services et manipule des données, des concepts métier, qui jouent souvent un rôle plus large et plus durable que l'application elle-même. 
 
-La [Doctrine API](../../2-donnees-et-api/3-strategie-api/sommaire/) décrit les principes, les pratiques et les règles que les développeurs doivent suivrent pour garantir que les API sont conçus développées et maintenues de manière cohérente et efficace.
+La [**doctrine API**](../../2-donnees-et-api/3-strategie-api/introduction/) décrit les principes, les pratiques et les règles que les développeurs doivent suivrent pour garantir que les API sont conçus développées et maintenues de manière cohérente et efficace.
 
 Toute application doit, de plus, adresser, sans conditions, les questions élémentaires suivantes :
 

content/fr/5-socle-d-architecture/2-donnees-et-api/3-strategie-api/introduction.md

@@ -1,13 +1,15 @@
 ---
-title: Doctrine API -Introduction
+title: Doctrine API
 layout: layouts/page_date_readtime.njk
 showBreadcrumb: true
-date: Last Modified
+date: git Last Modified
 ---
 
+# Doctrine API
+
 ## <a name="intro">Introduction</a>
 
-Sous l’impulsion de la Stratégie État Plateforme lancée par la DINUM, de la loi pour une République Numérique et de la [loi 3DS](https://www.economie.gouv.fr/daj/lettre-de-la-daj-application-de-la-loi-3ds-echange-de-donnees-entre-administrations), les systèmes d’information des ministères sont amenés à s’ouvrir. De même, la notion de plateforme incite à la mise en commun de données et de services de l’État dans un objectif de construction d’un écosystème d’acteurs publics ou privés. Ces derniers pourront alors les assembler pour construire ou rénover les services à destination des usagers de l’Administration.
+Sous l’impulsion de la Stratégie État Plateforme lancée par la DINUM, de la loi pour une République Numérique et de la <a href="https://www.economie.gouv.fr/daj/lettre-de-la-daj-application-de-la-loi-3ds-echange-de-donnees-entre-administrations" target="_blank">loi 3DS</a>, les systèmes d’information des ministères sont amenés à s’ouvrir. De même, la notion de plateforme incite à la mise en commun de données et de services de l’État dans un objectif de construction d’un écosystème d’acteurs publics ou privés. Ces derniers pourront alors les assembler pour construire ou rénover les services à destination des usagers de l’Administration.
 
 La construction de cet État Plateforme repose sur l’utilisation d’interfaces de programmation applicative appelées API (Application Programming Interface). Cette technologie s’appuie sur des standards largement éprouvés par les géants du Web tels que Google, Amazon ou encore Twitter. Une telle plateforme permet la collaboration au sein de l’écosystème, mais également l’expérimentation de nouveaux services publics numériques dans des délais et des coûts réduits.
 
@@ -17,7 +19,7 @@ Ce document se veut un cadre pour la conception et la réalisation d’API. Celu
 
 Pour remplir cette promesse, les API mises en place dans le cadre de l’État Plateforme doivent pouvoir être assemblées et interopérer. Le respect des standards est un élément essentiel mais pas suffisant pour atteindre cet objectif. En effet, ils focalisent sur les aspects techniques sans explicitement adresser les besoins fonctionnels et métiers. Ce sont pourtant ces derniers qui donnent un sens à l’utilisation ou à la création d’une API.
 
-C’est pour ces raisons qu’il est essentiel, en complément du respect des standards, de définir une stratégie claire des API répondant aux enjeux métiers. Pour cela, on s’attachera, lors de la conception d’une API, aux aspect fonctionnels et métiers des services fournis :
+C’est pour ces raisons qu’il est essentiel, en complément du respect des standards, de définir une stratégie claire des API répondant aux enjeux métiers. Pour cela, **on s’attachera**, lors de la conception d’une API, **aux aspect fonctionnels et métiers des services fournis** :
 
 - format de la donnée facilitant son utilisation quelques soient les contextes;
 - sollicitation au fil de l’eau (intégration dans les processus des partenaires);
@@ -27,11 +29,53 @@ C’est pour ces raisons qu’il est essentiel, en complément du respect des st
 
 ## <a name="choix">Choix technologiques</a>
 
-La stratégie État Plateforme met en avant certains standards qui sont également utilisés dans les différentes API construites par des acteurs publics et disponibles sur <a href="https://api.gouv.fr/" target="_blank"> api.gouv.fr</a> :
+La stratégie État Plateforme met en avant certains standards et <a href="https://api.gouv.fr/guides/doctrine-api" target="_blank">recommendations</a> qui sont également utilisés dans les différentes API construites par des acteurs publics et disponibles sur <a href="https://api.gouv.fr/" target="_blank"> api.gouv.fr</a> :
 
 - l’architecture REST et <a href="https://restfulapi.net/" target="_blank">API RESTful</a> pour l’appel et l’utilisation des API;
 - <a href="https://github.com/OAI/OpenAPI-Specification" target="_blank"> la spécification OpenAPI</a> et <a href="http://swagger.io/" target="_blank">le framework swagger</a> pour la documentation des API;
 - <a href="http://www.json.org/" target="_blank"> le format JSON</a> pour la structuration des données
 
+</br>
+
+
+<div class="fr-grid-row fr-grid-row--gutters fr-mb-4w">
+    <div class="fr-col-12 fr-col-md-4">
+                {% from "components/component.njk" import component with context %}
+                <div>
+                    {{ component("card", {
+                        url: "/5-socle-d-architecture/2-donnees-et-api/3-strategie-api/principes",
+                        title: "Les principes",
+                        description: "Une API doit exposer des services métiers",
+                        tags: ["api"],
+                        date: "2023-06-21" | jsDateObject,
+                        badges: [],
+                        image: {
+                            path: "../../../../../public/img/undraw_Services_re_hu5n.png",
+                            alt: "principes"
+                        },
+                        orientation: horizontal
+                    }) }}
+                </div>
+    </div>
+    <div class="fr-col-12 fr-col-md-4">
+                {% from "components/component.njk" import component with context %}
+                <div>
+                    {{ component("card", {
+                        url: "/5-socle-d-architecture/2-donnees-et-api/3-strategie-api/regles",
+                        title: "Les règles",
+                        description: "Les règles et précisions associées aux principes",
+                        tags: ["api"],
+                        date: "2023-06-21" | jsDateObject,
+                        badges: [],
+                        image: {
+                            path: "../../../../../public/img/undraw_Terms_re_6ak4.png",
+                            alt: "regles"
+                        },
+                        oriental: horizontal
+                    }) }}
+                </div>
+    </div>
+</div>
+
 
 {% include "components/back_to_top.njk" %}