Change project layout, add api, add doc (#2)

Update template layout, swagger api + doc
dwarvesf · Aug 15, 2018 · ad2f972 · ad2f972
1 parent 1afca9e
commit ad2f972
Show file tree

Hide file tree

Showing 17 changed files with 71 additions and 16 deletions.
diff --git a/sao.js b/sao.js
@@ -9,14 +9,14 @@ module.exports = {
   gitInit: false,
   installDependencies: false,
   prompts: {
-    namespace: {
-      message: 'What is your vsc namespace?',
-      default: 'dwarvesf',
-    },
     domain: {
       message: 'What is your vsc domain?',
       default: 'github.com',
     },
+    namespace: {
+      message: 'What is your vsc namespace?',
+      default: ':gitUser:',
+    },
     description: {
       message: 'How would you describe the new project?',
       default: `my ${superb()} Go project`,

diff --git a/template/api/swagger.yaml b/template/api/swagger.yaml
@@ -0,0 +1,55 @@
+swagger: "2.0"
+info:
+  description: "<%= description %>"
+  version: "1.0.0"
+  title: "<%= _.folderName %> API Document"
+host: "localhost:3000"
+basePath: "/"
+tags:
+- name: "add"
+  description: "add service"
+schemes:
+- "http"
+paths:
+  /add:
+    post:
+      tags:
+      - "add"
+      summary: "Add 2 value"
+      description: "add 2 value and return response"
+      operationId: "add"
+      consumes:
+      - "application/json"
+      produces:
+      - "application/json"
+      parameters:
+      - in: "body"
+        name: "body"
+        description: "add 2 value and return response"
+        required: true
+        schema:
+          $ref: "#/definitions/add_post_req"
+      responses:
+        200:
+          description: "successful operation"
+          schema:
+            $ref: "#/definitions/add_post_res"
+
+definitions:
+  add_post_req:
+    type: "object"
+    properties:
+      add:
+        type: "object"
+        properties:
+          x:
+            type: "integer"
+            format: "int32"
+          y:
+            type: "integer"
+            format: "int32"
+  add_post_res:
+    properties:
+          result:
+            type: "integer"
+            format: "int32"
diff --git a/template/cmd/server/main.go b/template/cmd/server/main.go
@@ -10,12 +10,12 @@ import (
 
 	"github.com/go-kit/kit/log"
 
-	"<%= domainDir + _.folderName %>/endpoints"
-	serviceHttp "<%= domainDir + _.folderName %>/http"
-	"<%= domainDir + _.folderName %>/middlewares"
-	"<%= domainDir + _.folderName %>/postgres"
-	"<%= domainDir + _.folderName %>/service"
-	"<%= domainDir + _.folderName %>/service/add"
+	"<%= domainDir + _.folderName %>/src/endpoints"
+	serviceHttp "<%= domainDir + _.folderName %>/src/http"
+	"<%= domainDir + _.folderName %>/src/middlewares"
+	"<%= domainDir + _.folderName %>/src/postgres"
+	"<%= domainDir + _.folderName %>/src/service"
+	"<%= domainDir + _.folderName %>/src/service/add"
 )
 
 func main() {

diff --git a/template/doc/.gitkeep b/template/doc/.gitkeep
diff --git a/template/endpoints/add.go → template/src/endpoints/add.go b/template/endpoints/add.go → template/src/endpoints/add.go
@@ -5,8 +5,8 @@ import (
 
 	"github.com/go-kit/kit/endpoint"
 
-	"<%= domainDir + _.folderName %>/service"
-	"<%= domainDir + _.folderName %>/service/add"
+	"<%= domainDir + _.folderName %>/src/service"
+	"<%= domainDir + _.folderName %>/src/service/add"
 )
 
 type AddRequest struct {

diff --git a/template/endpoints/endpoints.go → template/src/endpoints/endpoints.go b/template/endpoints/endpoints.go → template/src/endpoints/endpoints.go
@@ -3,7 +3,7 @@ package endpoints
 import (
 	"github.com/go-kit/kit/endpoint"
 
-	"<%= domainDir + _.folderName %>/service"
+	"<%= domainDir + _.folderName %>/src/service"
 )
 
 type Endpoints struct {

diff --git a/template/http/encode.go → template/src/http/encode.go b/template/http/encode.go → template/src/http/encode.go
diff --git a/template/http/http.go → template/src/http/http.go b/template/http/http.go → template/src/http/http.go
@@ -10,8 +10,8 @@ import (
 	"github.com/go-kit/kit/log"
 	httptransport "github.com/go-kit/kit/transport/http"
 
-	"<%= domainDir + _.folderName %>/endpoints"
-	"<%= domainDir + _.folderName %>/service"
+	"<%= domainDir + _.folderName %>/src/endpoints"
+	"<%= domainDir + _.folderName %>/src/service"
 )
 
 // NewHTTPHandler ...

diff --git a/template/middlewares/compose.go → template/src/middlewares/compose.go b/template/middlewares/compose.go → template/src/middlewares/compose.go
diff --git a/template/postgres/postgres.go → template/src/postgres/postgres.go b/template/postgres/postgres.go → template/src/postgres/postgres.go
diff --git a/template/service/add/add.go → template/src/service/add/add.go b/template/service/add/add.go → template/src/service/add/add.go
diff --git a/template/service/add/error.go → template/src/service/add/error.go b/template/service/add/error.go → template/src/service/add/error.go
diff --git a/template/service/add/mw_logging.go → template/src/service/add/mw_logging.go b/template/service/add/mw_logging.go → template/src/service/add/mw_logging.go
diff --git a/template/service/add/mw_validation.go → template/src/service/add/mw_validation.go b/template/service/add/mw_validation.go → template/src/service/add/mw_validation.go
diff --git a/template/service/add/pg.go → template/src/service/add/pg.go b/template/service/add/pg.go → template/src/service/add/pg.go
diff --git a/template/service/add/service.go → template/src/service/add/service.go b/template/service/add/service.go → template/src/service/add/service.go
diff --git a/template/service/service.go → template/src/service/service.go b/template/service/service.go → template/src/service/service.go
@@ -1,6 +1,6 @@
 package service
 
-import "<%= domainDir + _.folderName %>/service/add"
+import "<%= domainDir + _.folderName %>/src/service/add"
 
 // Service ...
 type Service struct {