add swagger example

add swagger package
fix test
2024-05-06 20:37:03 +02:00 · 2024-05-06 20:36:48 +02:00 · 2024-05-06 19:44:15 +02:00 · 2024-05-06 19:44:08 +02:00 · 2024-05-06 19:15:21 +02:00 · 2024-05-05 16:24:19 +02:00
12 changed files with 421 additions and 49 deletions
--- a/.github/workflows/build_docker_astro.yml
+++ b/.github/workflows/build_docker_astro.yml
@ -6,9 +6,9 @@ on: #declancheur
      - '*'
    tags:
      - v*
-  # pull_request:
-  #   branches:
-  #     - master
+  pull_request:
+    branches:
+      - master

 jobs:
  run: #jobs ID (nom du jobs)
@ -32,8 +32,6 @@ jobs:
          type=semver,pattern={{major}}.{{minor}}
          type=semver,pattern={{major}}
          type=semver,pattern=latest
-        labels: |
-          org.opencontainers.image.title=AstroFront

    - name: Login to Gitea
      uses: docker/login-action@v3
--- a/.github/workflows/build_docker_express.yml
+++ b/.github/workflows/build_docker_express.yml
@ -32,8 +32,6 @@ jobs:
          type=semver,pattern={{major}}.{{minor}}
          type=semver,pattern={{major}}
          type=semver,pattern=latest
-        labels: |
-          org.opencontainers.image.title=AstroFront

    - name: Login to Gitea
      uses: docker/login-action@v3
@ -48,8 +46,8 @@ jobs:
    - name: Build and push back
      uses: docker/build-push-action@v5
      with:
-        context: ./front
+        context: ./Express/barAndCafe
        push: true
-        file: ./front/Dockerfile
+        file: ./Express/barAndCafe/Dockerfile
        tags: ${{ steps.meta.outputs.tags }}
        labels: ${{ steps.meta.outputs.labels }}
--- a/.github/workflows/build_jsdoc_drink.yml
+++ b/.github/workflows/build_jsdoc_drink.yml
@ -0,0 +1,46 @@
+name: JsDocs
+on:
+  pull_request:
+    branches:
+      - '*'
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout # rapatrie le depot
+      uses: actions/checkout@v3
+    
+
+    - name: Docker meta
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: |
+          git.lab-ouest.org/Epitech/ratrapage_T-WEB_drink_jsdocs
+        tags: |
+          type=edge
+          type=ref,event=pr
+          type=ref,event=branch
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=semver,pattern={{major}}
+          type=semver,pattern=latest
+
+    - name: Login to Gitea
+      uses: docker/login-action@v3
+      with:
+        registry: git.lab-ouest.org
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_TOKEN }}
+
+    # - name: Set up Docker Buildx
+    #   uses: docker/setup-buildx-action@v3
+
+    - name: Build and push back
+      uses: docker/build-push-action@v5
+      with:
+        context: ./Express/barAndCafe
+        push: true
+        file: ./Express/barAndCafe/Dockerfile_docs
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}
--- a/Express/barAndCafe/Dockerfile
+++ b/Express/barAndCafe/Dockerfile
@ -1,5 +1,3 @@
-# This Dockerfile allows you to run AstroJS in server mode
-
 #########
 # Build #
 #########
--- a/Express/barAndCafe/Dockerfile_docs
+++ b/Express/barAndCafe/Dockerfile_docs
@ -0,0 +1,35 @@
+#########
+# Build #
+#########
+FROM docker.io/node:20-alpine as BUILD_IMAGE
+
+# External deps (for node-gyp add: "python3 make g++")
+RUN apk add --no-cache git
+
+# run as non root user
+USER node
+
+# go to user repository
+WORKDIR /home/node
+
+# Add package json
+ADD --chown=node:node package.json package-lock.json ./
+
+# install dependencies from package lock
+RUN npm ci
+
+# Add project files
+ADD --chown=node:node . .
+
+# build
+RUN npm run docs
+
+# remove dev deps
+RUN npm prune --omit=dev
+
+##############
+# Production #
+##############
+FROM httpd:alpine
+
+COPY --from=BUILD_IMAGE /home/node/out/ /usr/local/apache2/htdocs/
--- a/Express/barAndCafe/package-lock.json
+++ b/Express/barAndCafe/package-lock.json
@ -9,7 +9,9 @@
        "@types/node": "^20.12.7",
        "dotenv": "^16.4.5",
        "express": "^4.19.2",
-        "rimraf": "^5.0.5"
+        "rimraf": "^5.0.5",
+        "swagger-jsdoc": "^6.2.8",
+        "swagger-ui-express": "^5.0.0"
      },
      "devDependencies": {
        "@types/jest": "^29.5.12",
@ -40,6 +42,62 @@
        "node": ">=6.0.0"
      }
    },
+    "node_modules/@apidevtools/json-schema-ref-parser": {
+      "version": "9.1.2",
+      "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz",
+      "integrity": "sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==",
+      "dependencies": {
+        "@jsdevtools/ono": "^7.1.3",
+        "@types/json-schema": "^7.0.6",
+        "call-me-maybe": "^1.0.1",
+        "js-yaml": "^4.1.0"
+      }
+    },
+    "node_modules/@apidevtools/json-schema-ref-parser/node_modules/argparse": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+      "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+    },
+    "node_modules/@apidevtools/json-schema-ref-parser/node_modules/js-yaml": {
+      "version": "4.1.0",
+      "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+      "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+      "dependencies": {
+        "argparse": "^2.0.1"
+      },
+      "bin": {
+        "js-yaml": "bin/js-yaml.js"
+      }
+    },
+    "node_modules/@apidevtools/openapi-schemas": {
+      "version": "2.1.0",
+      "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz",
+      "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==",
+      "engines": {
+        "node": ">=10"
+      }
+    },
+    "node_modules/@apidevtools/swagger-methods": {
+      "version": "3.0.2",
+      "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz",
+      "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg=="
+    },
+    "node_modules/@apidevtools/swagger-parser": {
+      "version": "10.0.3",
+      "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.0.3.tgz",
+      "integrity": "sha512-sNiLY51vZOmSPFZA5TF35KZ2HbgYklQnTSDnkghamzLb3EkNtcQnrBQEj5AOCxHpTtXpqMCRM1CrmV2rG6nw4g==",
+      "dependencies": {
+        "@apidevtools/json-schema-ref-parser": "^9.0.6",
+        "@apidevtools/openapi-schemas": "^2.0.4",
+        "@apidevtools/swagger-methods": "^3.0.2",
+        "@jsdevtools/ono": "^7.1.3",
+        "call-me-maybe": "^1.0.1",
+        "z-schema": "^5.0.1"
+      },
+      "peerDependencies": {
+        "openapi-types": ">=7"
+      }
+    },
    "node_modules/@babel/code-frame": {
      "version": "7.24.2",
      "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.2.tgz",
@ -1515,6 +1573,11 @@
        "@jridgewell/sourcemap-codec": "^1.4.14"
      }
    },
+    "node_modules/@jsdevtools/ono": {
+      "version": "7.1.3",
+      "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz",
+      "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg=="
+    },
    "node_modules/@jsdoc/salty": {
      "version": "0.2.8",
      "resolved": "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.8.tgz",
@ -1709,6 +1772,11 @@
        "pretty-format": "^29.0.0"
      }
    },
+    "node_modules/@types/json-schema": {
+      "version": "7.0.15",
+      "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
+      "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="
+    },
    "node_modules/@types/linkify-it": {
      "version": "5.0.0",
      "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-5.0.0.tgz",
@ -3503,7 +3571,6 @@
      "version": "1.1.11",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
      "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
-      "dev": true,
      "dependencies": {
        "balanced-match": "^1.0.0",
        "concat-map": "0.0.1"
@ -3855,6 +3922,11 @@
        "url": "https://github.com/sponsors/ljharb"
      }
    },
+    "node_modules/call-me-maybe": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz",
+      "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ=="
+    },
    "node_modules/callsites": {
      "version": "3.1.0",
      "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz",
@ -4273,8 +4345,7 @@
    "node_modules/concat-map": {
      "version": "0.0.1",
      "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
-      "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==",
-      "dev": true
+      "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="
    },
    "node_modules/constantinople": {
      "version": "3.1.2",
@ -4615,7 +4686,6 @@
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz",
      "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==",
-      "dev": true,
      "dependencies": {
        "esutils": "^2.0.2"
      },
@ -4775,7 +4845,6 @@
      "version": "2.0.3",
      "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz",
      "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==",
-      "dev": true,
      "engines": {
        "node": ">=0.10.0"
      }
@ -5173,8 +5242,7 @@
    "node_modules/fs.realpath": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
-      "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==",
-      "dev": true
+      "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw=="
    },
    "node_modules/fsevents": {
      "version": "2.3.3",
@ -5676,7 +5744,6 @@
      "version": "1.0.6",
      "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
      "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==",
-      "dev": true,
      "dependencies": {
        "once": "^1.3.0",
        "wrappy": "1"
@ -7734,14 +7801,12 @@
    "node_modules/lodash.get": {
      "version": "4.4.2",
      "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz",
-      "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==",
-      "dev": true
+      "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ=="
    },
    "node_modules/lodash.isequal": {
      "version": "4.5.0",
      "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
-      "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==",
-      "dev": true
+      "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ=="
    },
    "node_modules/lodash.memoize": {
      "version": "4.1.2",
@ -7749,6 +7814,11 @@
      "integrity": "sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==",
      "dev": true
    },
+    "node_modules/lodash.mergewith": {
+      "version": "4.6.2",
+      "resolved": "https://registry.npmjs.org/lodash.mergewith/-/lodash.mergewith-4.6.2.tgz",
+      "integrity": "sha512-GK3g5RPZWTRSeLSpgP8Xhra+pnjBC56q9FZYe1d5RN3TJ35dbkGy3YqBSMbyCrlbi+CM9Z3Jk5yTL7RCsqboyQ=="
+    },
    "node_modules/longest": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/longest/-/longest-1.0.1.tgz",
@ -7991,7 +8061,6 @@
      "version": "3.1.2",
      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
-      "dev": true,
      "dependencies": {
        "brace-expansion": "^1.1.7"
      },
@ -8385,7 +8454,6 @@
      "version": "1.4.0",
      "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
      "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
-      "dev": true,
      "dependencies": {
        "wrappy": "1"
      }
@ -8405,6 +8473,12 @@
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
+    "node_modules/openapi-types": {
+      "version": "12.1.3",
+      "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz",
+      "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==",
+      "peer": true
+    },
    "node_modules/os-homedir": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/os-homedir/-/os-homedir-1.0.2.tgz",
@ -8573,7 +8647,6 @@
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
      "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==",
-      "dev": true,
      "engines": {
        "node": ">=0.10.0"
      }
@ -10151,6 +10224,82 @@
        "url": "https://github.com/sponsors/ljharb"
      }
    },
+    "node_modules/swagger-jsdoc": {
+      "version": "6.2.8",
+      "resolved": "https://registry.npmjs.org/swagger-jsdoc/-/swagger-jsdoc-6.2.8.tgz",
+      "integrity": "sha512-VPvil1+JRpmJ55CgAtn8DIcpBs0bL5L3q5bVQvF4tAW/k/9JYSj7dCpaYCAv5rufe0vcCbBRQXGvzpkWjvLklQ==",
+      "dependencies": {
+        "commander": "6.2.0",
+        "doctrine": "3.0.0",
+        "glob": "7.1.6",
+        "lodash.mergewith": "^4.6.2",
+        "swagger-parser": "^10.0.3",
+        "yaml": "2.0.0-1"
+      },
+      "bin": {
+        "swagger-jsdoc": "bin/swagger-jsdoc.js"
+      },
+      "engines": {
+        "node": ">=12.0.0"
+      }
+    },
+    "node_modules/swagger-jsdoc/node_modules/commander": {
+      "version": "6.2.0",
+      "resolved": "https://registry.npmjs.org/commander/-/commander-6.2.0.tgz",
+      "integrity": "sha512-zP4jEKbe8SHzKJYQmq8Y9gYjtO/POJLgIdKgV7B9qNmABVFVc+ctqSX6iXh4mCpJfRBOabiZ2YKPg8ciDw6C+Q==",
+      "engines": {
+        "node": ">= 6"
+      }
+    },
+    "node_modules/swagger-jsdoc/node_modules/glob": {
+      "version": "7.1.6",
+      "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz",
+      "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==",
+      "dependencies": {
+        "fs.realpath": "^1.0.0",
+        "inflight": "^1.0.4",
+        "inherits": "2",
+        "minimatch": "^3.0.4",
+        "once": "^1.3.0",
+        "path-is-absolute": "^1.0.0"
+      },
+      "engines": {
+        "node": "*"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/isaacs"
+      }
+    },
+    "node_modules/swagger-parser": {
+      "version": "10.0.3",
+      "resolved": "https://registry.npmjs.org/swagger-parser/-/swagger-parser-10.0.3.tgz",
+      "integrity": "sha512-nF7oMeL4KypldrQhac8RyHerJeGPD1p2xDh900GPvc+Nk7nWP6jX2FcC7WmkinMoAmoO774+AFXcWsW8gMWEIg==",
+      "dependencies": {
+        "@apidevtools/swagger-parser": "10.0.3"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
+    "node_modules/swagger-ui-dist": {
+      "version": "5.17.5",
+      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-5.17.5.tgz",
+      "integrity": "sha512-QlkO9OJlSOZbXx4bbQcV18RDmt7RgbO1fh2gL3hipFtPXEh0ejjNT+Oe5lchkTadawd6XSvnCcwFkr2xy3HtxA=="
+    },
+    "node_modules/swagger-ui-express": {
+      "version": "5.0.0",
+      "resolved": "https://registry.npmjs.org/swagger-ui-express/-/swagger-ui-express-5.0.0.tgz",
+      "integrity": "sha512-tsU9tODVvhyfkNSvf03E6FAk+z+5cU3lXAzMy6Pv4av2Gt2xA0++fogwC4qo19XuFf6hdxevPuVCSKFuMHJhFA==",
+      "dependencies": {
+        "swagger-ui-dist": ">=5.0.0"
+      },
+      "engines": {
+        "node": ">= v0.10.32"
+      },
+      "peerDependencies": {
+        "express": ">=4.0.0 || >=5.0.0-beta"
+      }
+    },
    "node_modules/test-exclude": {
      "version": "6.0.0",
      "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz",
@ -10678,6 +10827,14 @@
        "node": ">= 0.10.0"
      }
    },
+    "node_modules/validator": {
+      "version": "13.11.0",
+      "resolved": "https://registry.npmjs.org/validator/-/validator-13.11.0.tgz",
+      "integrity": "sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ==",
+      "engines": {
+        "node": ">= 0.10"
+      }
+    },
    "node_modules/vary": {
      "version": "1.1.2",
      "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
@ -10932,8 +11089,7 @@
    "node_modules/wrappy": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
-      "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
-      "dev": true
+      "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="
    },
    "node_modules/write-file-atomic": {
      "version": "4.0.2",
@ -10975,6 +11131,14 @@
      "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==",
      "dev": true
    },
+    "node_modules/yaml": {
+      "version": "2.0.0-1",
+      "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.0.0-1.tgz",
+      "integrity": "sha512-W7h5dEhywMKenDJh2iX/LABkbFnBxasD27oyXWDS/feDsxiw0dD5ncXdYXgkvAsXIY2MpW/ZKkr9IU30DBdMNQ==",
+      "engines": {
+        "node": ">= 6"
+      }
+    },
    "node_modules/yargs": {
      "version": "17.7.2",
      "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz",
@ -11054,6 +11218,34 @@
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
+    },
+    "node_modules/z-schema": {
+      "version": "5.0.5",
+      "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz",
+      "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==",
+      "dependencies": {
+        "lodash.get": "^4.4.2",
+        "lodash.isequal": "^4.5.0",
+        "validator": "^13.7.0"
+      },
+      "bin": {
+        "z-schema": "bin/z-schema"
+      },
+      "engines": {
+        "node": ">=8.0.0"
+      },
+      "optionalDependencies": {
+        "commander": "^9.4.1"
+      }
+    },
+    "node_modules/z-schema/node_modules/commander": {
+      "version": "9.5.0",
+      "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz",
+      "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==",
+      "optional": true,
+      "engines": {
+        "node": "^12.20.0 || >=14"
+      }
    }
  }
 }
--- a/Express/barAndCafe/package.json
+++ b/Express/barAndCafe/package.json
@ -2,9 +2,9 @@
  "main": "dist/server.js",
  "scripts": {
    "build": "rimraf dist && npx tsc",
-    "start": "node dist/index.js",
+    "start": "node dist/src/server.js",
    "predev": "npm run build",
-    "dev": "npx tsc -w & nodemon dist/server.js",
+    "dev": "npx tsc -w & nodemon dist/src/server.js",
    "docs": "jsdoc -c jsdoc.json",
    "test": "jest"
  },
@ -13,7 +13,9 @@
    "@types/node": "^20.12.7",
    "dotenv": "^16.4.5",
    "express": "^4.19.2",
-    "rimraf": "^5.0.5"
+    "rimraf": "^5.0.5",
+    "swagger-jsdoc": "^6.2.8",
+    "swagger-ui-express": "^5.0.0"
  },
  "devDependencies": {
    "@types/jest": "^29.5.12",
--- a/Express/barAndCafe/src/app.ts
+++ b/Express/barAndCafe/src/app.ts
@ -1,22 +1,32 @@
-import express from "express";
+import express from "express"
 /**
 * Initialize Express application instance.
 * @returns An initialized Express application object.
 */
-const app = express();
+const app = express()



 /**
- * Handle GET request for homepage route ('/').
- * Send back a simple text response.
+ * Handle GET request for homepage route ('/welcome').
+ * Send back a simple json response.
 * @param {express.Request} req - HTTP Request object.
 * @param {express.Response} res - HTTP Response object.
 */
-function getRoot(req: express.Request, res: express.Response) {
-    res.send("hello world from dev");
+function getWelcome(req: express.Request, res: express.Response) {
+    const out = {hello:"world"}
+    res.send(out)
 }

-app.get("/", getRoot);
+/**
+ * @openapi
+ * /welcome:
+ *   get:
+ *     description: Welcome to swagger-jsdoc!
+ *     responses:
+ *       200:
+ *         description: Returns a welcome json.
+ */
+app.get("/welcome", getWelcome)

-export default app;
+export default app
--- a/Express/barAndCafe/src/server.ts
+++ b/Express/barAndCafe/src/server.ts
@ -1,10 +1,16 @@
 import * as dotenv from "dotenv";
 import app from "./app";
+import options from "./swaggerDef";
+const swaggerJsdoc = require("swagger-jsdoc"),
+    swaggerUi = require("swagger-ui-express");

 dotenv.config({path: '../../.env'})

 const port = parseInt(process.env.BAR_PORT || '3000')

+const specs = swaggerJsdoc(options)
+app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(specs))
+
 app.listen(port, () =>{
    console.log(`serveur running in ${port}`)
 })
--- a/Express/barAndCafe/src/swaggerDef.ts
+++ b/Express/barAndCafe/src/swaggerDef.ts
@ -0,0 +1,25 @@
+import * as dotenv from "dotenv";
+dotenv.config({path: '../../.env'})
+const port = parseInt(process.env.BAR_PORT || '3000')
+
+
+const options = {
+	definition: {
+	  openapi: "3.1.0",
+	  info: {
+		title: "LogRocket Express API with Swagger",
+		version: "0.1.0",
+		description:
+		  "This is a simple CRUD API application made with Express and documented with Swagger",
+	  },
+	  servers: [
+		{
+		  url: "http://localhost:"+port.toString(),
+		},
+	  ],
+	},
+  apis: ['./src/*.ts'],
+  }
+
+
+export default options
--- a/Express/barAndCafe/test/app.test.ts
+++ b/Express/barAndCafe/test/app.test.ts
@ -1,12 +1,14 @@
 import request from "supertest";
 import app from "../src/app";
 import { Server, IncomingMessage, ServerResponse } from "http";
+import * as dotenv from "dotenv";

-const port = 3000;
+dotenv.config({path: '../../.env'})
+const port = parseInt(process.env.BAR_PORT || '3000')

 let serveur : Server<typeof IncomingMessage, typeof ServerResponse>

-describe("Test the root path", () => {
+describe("Test the welcome path", () => {

    beforeEach(() => {
        serveur = app.listen(port, () =>{
@ -20,7 +22,7 @@ describe("Test the root path", () => {

    test("It should response the GET method", done => {
        request(app)
-        .get("/")
+        .get("/welcome")
        .then(response => {
            expect(response.statusCode).toBe(200);
            done();
@ -28,10 +30,11 @@ describe("Test the root path", () => {
    });

    test("It should response the GET method", done => {
+        const out = {hello:"world"};
        request(app)
-        .get("/")
+        .get("/welcome")
        .then(response => {
-            expect(response.text).toEqual("hello world from dev")
+            expect(response.text).toEqual(JSON.stringify(out))
            done();
        });
    });
--- a/docker-compose.yml
+++ b/docker-compose.yml
@ -1,12 +1,14 @@
 version: "3.8"
+
 services:
+
  pocketbase:
    image: ghcr.io/coollabsio/pocketbase:latest
    environment:
      - SERVICE_FQDN_POCKETBASE_8080
    volumes:
-      - ./.pb/pocketbase-data:/app/pb_data
-      - ./.pb/pocketbase-hooks:/app/pb_hooks
+      - ./pb/pocketbase-data:/app/pb_data
+      - ./pb/pocketbase-hooks:/app/pb_hooks
    labels:
      - traefik.enable=true
      - traefik.http.routers.poketBaseTweb.rule=Host(`${POCKET_BASE_URL}`)
@ -14,8 +16,9 @@ services:
      - traefik.http.routers.poketBaseTweb.tls.certresolver=le
    networks:
      - public
+
  front:
-    image: git.lab-ouest.org/epitech/ratrapage_t-web_front:pr-7-head
+    image: git.lab-ouest.org/epitech/ratrapage_t-web_front:pr-1-head
    depends_on:
      - pocketbase
    labels:
@ -25,10 +28,66 @@ services:
      - traefik.http.routers.astroTweb.tls.certresolver=le
    networks:
      - public
+
+  back_drink:
+    image: git.lab-ouest.org/epitech/ratrapage_t-web_back:pr-6-head
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.expressDrinkTweb.rule=Host(`${DRINK_URL}`)
+      - traefik.http.services.expressDrinkTweb.loadbalancer.server.port=${BACK_BASE_PORT}
+      - traefik.http.routers.expressDrinkTweb.tls.certresolver=le
+    networks:
+      - public
+
+  docs_drink:
+    image: git.lab-ouest.org/epitech/ratrapage_t-web_drink_jsdocs:pr-6-head
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.docsDrinkTweb.rule=Host(`${DOCS_DRINK_URL}`)
+      - traefik.http.services.docsDrinkTweb.loadbalancer.server.port=${DOCS_BACK_BASE_PORT}
+      - traefik.http.routers.docsDrinkTweb.tls.certresolver=le
+    networks:
+      - public
+
+
+  blazegraph:
+    image: conjecto/blazegraph:2.1.5
+    # ports:
+    #   - 9999:9999
+    environment:
+      JAVA_OPTS: -Xms6G -Xmx6G
+    volumes:
+      - ./datatourisme/dataset:/docker-entrypoint-initdb.d
+    ulimits:
+      nofile:
+        soft: 65536
+        hard: 65536
+    networks:
+      - graphQL
+    restart: unless-stopped
+
+  datatourisme:
+    image: git.lab-ouest.org/epitech/fork-open-data-tourism:master
+    depends_on:
+      - blazegraph
+    networks:
+      - graphQL
+      - public
+    restart: unless-stopped
+    labels:
+      - traefik.enable=true
+      - traefik.http.routers.dataTourisme.rule=Host(`${DATA_TOURISME_URL}`)
+      - traefik.http.services.dataTourisme.loadbalancer.server.port=${DATA_TOURISME_BASE_PORT}
+      - traefik.http.routers.dataTourisme.tls.certresolver=le
+
 networks:
+  graphQL: {}
  public:
    external: true
 x-dockge:
  urls:
    - https://${POCKET_BASE_URL}/
    - https://${FRONT_URL}/
+    - https://${DOCS_DRINK_URL}/
+    - https://${DRINK_URL}/
+    - https://${DATA_TOURISME_URL}/
Author	SHA1	Message	Date
Clement	e69773fdd6	add swagger example Some checks failed Build Docker Image Front / run (push) Successful in 23s Details Build Docker Image Back / run (push) Successful in 1m7s Details Build Docker Image Front / run (pull_request) Successful in 23s Details Build Docker Image Back / run (pull_request) Successful in 20s Details JsDocs / coverage (pull_request) Failing after 26s Details Test and coverage / coverage (pull_request) Failing after 38s Details	2024-05-06 20:37:03 +02:00
Clement	9dbdde5419	add swagger package	2024-05-06 20:36:48 +02:00
Clement	adc63a097d	fix test All checks were successful Build Docker Image Front / run (push) Successful in 23s Details Build Docker Image Back / run (push) Successful in 1m4s Details Build Docker Image Front / run (pull_request) Successful in 22s Details Build Docker Image Back / run (pull_request) Successful in 21s Details JsDocs / coverage (pull_request) Successful in 33s Details Test and coverage / coverage (pull_request) Successful in 35s Details	2024-05-06 19:44:15 +02:00
Clement	75051827f7	fix dev and rename to welcome	2024-05-06 19:44:08 +02:00
Clement	4e4656f849	fix: add service to public network All checks were successful Build Docker Image Front / run (push) Successful in 34s Details Build Docker Image Back / run (push) Successful in 20s Details Build Docker Image Front / run (pull_request) Successful in 22s Details Build Docker Image Back / run (pull_request) Successful in 20s Details JsDocs / coverage (pull_request) Successful in 22s Details Test and coverage / coverage (pull_request) Successful in 40s Details	2024-05-06 19:15:21 +02:00
Clement	38aed020b4	fix run All checks were successful Build Docker Image Front / run (push) Successful in 23s Details Build Docker Image Back / run (push) Successful in 1m0s Details Build Docker Image Front / run (pull_request) Successful in 23s Details Build Docker Image Back / run (pull_request) Successful in 20s Details JsDocs / coverage (pull_request) Successful in 28s Details Test and coverage / coverage (pull_request) Successful in 36s Details	2024-05-05 16:24:19 +02:00
Clement	80a2e78d24	correction back for prod All checks were successful Build Docker Image Front / run (push) Successful in 22s Details Build Docker Image Back / run (push) Successful in 1m0s Details Build Docker Image Front / run (pull_request) Successful in 20s Details Build Docker Image Back / run (pull_request) Successful in 21s Details JsDocs / coverage (pull_request) Successful in 31s Details Test and coverage / coverage (pull_request) Successful in 41s Details	2024-05-05 16:02:39 +02:00
Clement	5bba62b733	feat: update docker compose and build All checks were successful Build Docker Image Front / run (push) Successful in 22s Details Build Docker Image Back / run (push) Successful in 41s Details Build Docker Image Front / run (pull_request) Successful in 22s Details Build Docker Image Back / run (pull_request) Successful in 21s Details JsDocs / coverage (pull_request) Successful in 21s Details Test and coverage / coverage (pull_request) Successful in 35s Details Reviewed-on: #10	2024-05-05 15:44:26 +02:00
Clement	77746e8a1a	feat: init-jsdocs (#9 ) All checks were successful Build Docker Image Front / run (push) Successful in 24s Details Build Docker Image Back / run (push) Successful in 21s Details Build Docker Image Front / run (pull_request) Successful in 21s Details Build Docker Image Back / run (pull_request) Successful in 21s Details JsDocs / coverage (pull_request) Successful in 22s Details Test and coverage / coverage (pull_request) Successful in 38s Details Reviewed-on: #9 Co-authored-by: Clement <c.boesmier@aptatio.com> Co-committed-by: Clement <c.boesmier@aptatio.com>	2024-05-05 14:46:44 +02:00
Clement	c6b509355f	fix: correction des TU jest All checks were successful Build Docker Image Front / run (push) Successful in 24s Details Build Docker Image Back / run (push) Successful in 21s Details Build Docker Image Front / run (pull_request) Successful in 21s Details Build Docker Image Back / run (pull_request) Successful in 20s Details Test and coverage / coverage (pull_request) Successful in 39s Details Reviewed-on: #8 Co-authored-by: Clement <c.boesmier@aptatio.com> Co-committed-by: Clement <c.boesmier@aptatio.com>	2024-05-04 19:32:33 +02:00