Swagger implementation to document Rest APIs

laradock · Sep 24, 2019 · da040d7 · da040d7
1 parent a036543
commit da040d7
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 0 deletions.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1577,3 +1577,21 @@ services:
         - postgres
       volumes:
         - ${DATA_PATH_HOST}/Confluence:/var/atlassian/application-data
+
+### SWAGGER EDITOR ############################################
+    swagger-editor:
+      build: ./swagger-editor
+      ports:
+        - ${SWAGGER_EDITOR_PORT}:8080
+      networks:
+        - backend
+
+### SWAGGER UI ################################################
+    swagger-ui:
+      build: ./swagger-ui
+      environment:
+        - API_URL=${SWAGGER_API_URL}
+      ports:
+        - ${SWAGGER_UI_PORT}:8080
+      networks:
+        - backend
diff --git a/env-example b/env-example
@@ -725,6 +725,15 @@ PGADMIN_PORT=5050
 PGADMIN_DEFAULT_EMAIL=pgadmin4@pgadmin.org
 PGADMIN_DEFAULT_PASSWORD=admin
 
+### SWAGGER EDITOR  ###########################################
+
+SWAGGER_EDITOR_PORT=5151
+
+### SWAGGER UI  ###############################################
+
+SWAGGER_API_URL=http://generator.swagger.io/api/swagger.json
+SWAGGER_UI_PORT=5555
+
 ### SONARQUBE ################################################
 ## docker-compose up -d sonarqube
 ## (If you encounter a database error)

diff --git a/swagger-editor/Dockerfile b/swagger-editor/Dockerfile
@@ -0,0 +1,3 @@
+FROM swaggerapi/swagger-editor:latest
+
+LABEL maintainer="Miguel Ortiz <miguelortiz1994@outlook.com>"
diff --git a/swagger-ui/Dockerfile b/swagger-ui/Dockerfile
@@ -0,0 +1,3 @@
+FROM swaggerapi/swagger-ui:latest
+
+LABEL maintainer="Miguel Ortiz <miguelortiz1994@outlook.com>"