updated swagger.json to openapi v3. added optional docker-compose with nginx proxy. started work on gitlab ci-yml for auto deployment

Author: Sean-Bradley

.gitlab-ci.yml

@@ -0,0 +1,50 @@
+image: docker:latest
+services:
+  - docker:dind
+
+stages:
+  - deploy
+
+step-deploy-uat:
+  stage: deploy
+  only:
+    - uat
+  tags:
+    - uat
+  script:
+    - sudo apt-get install -y python-pip
+    - pip install docker-compose
+    - sudo docker image prune -f
+    - sudo docker-compose -f docker-compose.yml build --no-cache
+    - sudo docker-compose -f docker-compose.yml up -d
+
+    #test the default url
+    - 'curl -k https://127.0.0.1/'
+    #test the api root
+    - 'curl -k https://127.0.0.1/api'
+    #test the getting some cats
+    - 'curl -k https://127.0.0.1/api/cats'
+
+step-deploy-prod:
+  stage: deploy
+  only:
+    - production
+  tags:
+    - production
+  script:
+    - sudo apt-get install -y python-pip
+    - pip install docker-compose
+    - sudo docker image prune -f
+    - sudo docker-compose -f docker-compose.yml build --no-cache
+    - sudo docker-compose -f docker-compose.yml up -d
+
+    #test the default url
+    - 'curl -k https://127.0.0.1/'
+    #test the api root
+    - 'curl -k https://127.0.0.1/api'
+    #test the getting some cats
+    - 'curl -k https://127.0.0.1/api/cats'
+  when: manual
+
+
+

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:alpine
+
+LABEL Sean Bradley <[email protected]>
+
+COPY package.json /nodejs/package.json
+COPY tsconfig.json /nodejs/tsconfig.json
+COPY /dist /nodejs/dist
+WORKDIR /nodejs
+
+RUN npm install
+RUN ls
+
+
+EXPOSE 3000:3000

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '2'
+services:
+  nginx:
+    build: 
+      context: .\nginx
+      dockerfile: Dockerfile
+    ports:
+      - "80:80"
+    command: nginx -g "daemon off";
+    depends_on:
+      - nodejs
+      
+  nodejs:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    expose:
+      - "3000"
+    command: npm start
+
+

nginx/Dockerfile

@@ -0,0 +1,6 @@
+FROM nginx
+LABEL Sean Bradley <[email protected]>
+COPY /nginx.conf	/etc/nginx/nginx.conf
+#COPY /server.crt	/etc/nginx/server.crt
+#COPY /server.key	/etc/nginx/server.key
+COPY /static	    /static

nginx/nginx.conf

@@ -0,0 +1,41 @@
+user www-data;
+worker_processes 1;
+pid /run/nginx.pid;
+events {
+    worker_connections 768;
+}
+http {
+    sendfile off;
+    tcp_nopush on;
+    tcp_nodelay on;
+    keepalive_timeout 65;
+    types_hash_max_size 2048;
+    include /etc/nginx/mime.types;
+    default_type application/octet-stream;
+    #access_log /var/log/nginx/access.log;
+    error_log /var/log/nginx/error.log;
+    gzip on;
+    gzip_disable "msie6";
+    server {
+        listen 80;
+        server_name localhost;
+#ssl_certificate      server.crt;
+#ssl_certificate_key  server.key;
+        location / {
+            root /static;
+            index index.html;
+        }
+        location /v1.0.1/ {
+            proxy_pass_header Server;
+            proxy_set_header Host $http_host;
+            proxy_set_header X-Real-IP $remote_addr;
+            proxy_set_header X-Scheme $scheme;
+            proxy_set_header X-Real-IP	$remote_addr;
+            proxy_set_header X-Forwarded-For	$proxy_add_x_forwarded_for;
+            proxy_redirect off;
+            proxy_connect_timeout 20;
+            proxy_read_timeout 20;
+            proxy_pass http://nodejs:3000/;
+        }
+    }
+}

nginx/static/index.html

@@ -0,0 +1 @@
+put the static html generated from you favourite front end framework here

package.json

@@ -1,6 +1,6 @@
 {
   "name": "seans-typescript-nodejs-crud-rest-api-boilerplate",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "main": "server.js",
   "scripts": {

src/router.ts

@@ -15,7 +15,7 @@ class Router {
 
         router.get('/', (req: express.Request, res: express.Response) => {
             res.json({
-                message: 'Nothing to see here, goto \'/cats\' instead'
+                message: `Nothing to see here, [url]/cats instead`
             })
         })
 

src/swagger.json

@@ -1,5 +1,5 @@
 {
-    "swagger": "2.0",
+    "openapi": "3.0.0",
     "info": {
         "version": "1.0.0",
         "title": "Seans-TypeScript-NodeJS-CRUD-REST-API-Boilerplate",
@@ -9,17 +9,22 @@
             "url": "https://opensource.org/licenses/MIT"
         }
     },
-    "host": "localhost:3000",
-    "basePath": "",
+    "servers": [
+        {
+            "url": "/",
+            "description": "Local Dev"
+        },
+        {
+            "url": "/v1.0.1/",
+            "description": "With docker-compose and nginx proxy"
+        }
+    ],
     "tags": [
         {
             "name": "Cats",
             "description": "API for cats in the system"
         }
     ],
-    "schemes": [
-        "http"
-    ],
     "consumes": [
         "application/json"
     ],