Improvements after review

Dockerfile-api

@@ -8,10 +8,10 @@ RUN GOOS=linux GOARCH=amd64 go build -v -mod mod -ldflags "-s -w" -o ./templates
 
 FROM scratch
 WORKDIR /app
-COPY --from=buildContainer /go/src/app/templatesapi .
+COPY --from=buildContainer /go/src/app/templatesapi /app/templatesapi
 
 ENV HOST 0.0.0.0
 ENV PORT 8000
 EXPOSE 8000
 
-CMD ["./templatesapi", "--http-port=8000", "--domain=0.0.0.0:8000"]
+CMD ["/app/templatesapi", "--http-port=8000", "--domain=0.0.0.0:8000"]

Makefile

@@ -36,9 +36,3 @@ fix:
 	bash ./scripts/fix.sh
 
 ci: mod lint tests
-
-api-generate:
-	goa gen github.com/keboola/keboola-as-code/design --output ./internal/pkg/template/api
-	rm -rf ./internal/pkg/template/api/gen/http/cli
-	rm -rf ./internal/pkg/template/api/gen/http/templates/client
-	mv ./internal/pkg/template/api/gen/http/openapi* ./api

design/templates.go → api/templates/design.go

@@ -1,5 +1,5 @@
 // nolint: gochecknoglobals
-package design
+package templates
 
 import (
 	_ "goa.design/goa/v3/codegen/generator"
@@ -9,9 +9,17 @@ import (
 var _ = API("templates", func() {
 	Title("Templates Service")
 	Description("A service for applying templates to Keboola projects")
+	Version("1.0")
+	HTTP(func() {
+		Path("v1")
+	})
 	Server("templates", func() {
-		Host("localhost", func() {
-			URI("http://localhost:8000")
+		Host("production", func() {
+			URI("https://templates.{stack}")
+			Variable("stack", String, "Base URL of the stack", func() {
+				Default("keboola.com")
+				Enum("keboola.com", "eu-central-1.keboola.com", "north-europe.azure.keboola.com")
+			})
 		})
 	})
 })
@@ -21,14 +29,27 @@ var index = ResultType("application/vnd.templates.index", func() {
 	TypeName("Index")
 
 	Attributes(func() {
-		Field(1, "api")
-		Field(2, "documentation")
+		Field(1, "api", String, "Name of the API", func() {
+			Example("templates")
+		})
+		Field(2, "documentation", String, "Url of the API documentation", func() {
+			Example("https://templates.keboola.com/v1/documentation")
+		})
+		Required("api", "documentation")
 	})
 })
 
 var _ = Service("templates", func() {
 	Description("Service for applying templates to Keboola projects")
 
+	Method("index-root", func() {
+		HTTP(func() {
+			// Redirect / -> /v1
+			GET("//")
+			Redirect("/v1", StatusMovedPermanently)
+		})
+	})
+
 	Method("index", func() {
 		Result(index)
 		HTTP(func() {

api/templates/gen/openapi.json

@@ -0,0 +1 @@
+{"swagger":"2.0","info":{"title":"Templates Service","description":"A service for applying templates to Keboola projects","version":"1.0"},"host":"templates.keboola.com","consumes":["application/json","application/xml","application/gob"],"produces":["application/json","application/xml","application/gob"],"paths":{"/":{"get":{"tags":["templates"],"summary":"index-root templates","operationId":"templates#index-root","responses":{"307":{"description":"Temporary Redirect response."}},"schemes":["https"]}},"/v1":{"get":{"tags":["templates"],"summary":"index templates","operationId":"templates#index","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/TemplatesIndexResponseBody"}}},"schemes":["https"]}},"/v1/health-check":{"get":{"tags":["templates"],"summary":"health-check templates","operationId":"templates#health-check","responses":{"200":{"description":"OK response."}},"schemes":["https"]}}},"definitions":{"TemplatesIndexResponseBody":{"title":"Mediatype identifier: application/vnd.templates.index; view=default","type":"object","properties":{"api":{"type":"string","description":"Name of the API","example":"templates"},"documentation":{"type":"string","description":"Url of the API documentation","example":"https://templates.keboola.com/v1/documentation"}},"description":"IndexResponseBody result type (default view)","example":{"api":"templates","documentation":"https://templates.keboola.com/v1/documentation"},"required":["api","documentation"]}}}

api/openapi.yaml → api/templates/gen/openapi.yaml

@@ -2,8 +2,8 @@ swagger: "2.0"
 info:
   title: Templates Service
   description: A service for applying templates to Keboola projects
-  version: ""
-host: localhost:8000
+  version: "1.0"
+host: templates.keboola.com
 consumes:
 - application/json
 - application/xml
@@ -14,6 +14,17 @@ produces:
 - application/gob
 paths:
   /:
+    get:
+      tags:
+      - templates
+      summary: index-root templates
+      operationId: templates#index-root
+      responses:
+        "307":
+          description: Temporary Redirect response.
+      schemes:
+      - https
+  /v1:
     get:
       tags:
       - templates
@@ -25,8 +36,8 @@ paths:
           schema:
             $ref: '#/definitions/TemplatesIndexResponseBody'
       schemes:
-      - http
-  /health-check:
+      - https
+  /v1/health-check:
     get:
       tags:
       - templates
@@ -36,32 +47,24 @@ paths:
         "200":
           description: OK response.
       schemes:
-      - http
-  /openapi.json:
-    get:
-      tags:
-      - templates
-      summary: Download ./gen/http/openapi.json
-      operationId: templates#/openapi.json
-      responses:
-        "200":
-          description: File downloaded
-          schema:
-            type: file
-      schemes:
-      - http
+      - https
 definitions:
   TemplatesIndexResponseBody:
     title: 'Mediatype identifier: application/vnd.templates.index; view=default'
     type: object
     properties:
       api:
         type: string
-        example: Fugit numquam quidem.
+        description: Name of the API
+        example: templates
       documentation:
         type: string
-        example: Accusantium voluptas.
+        description: Url of the API documentation
+        example: https://templates.keboola.com/v1/documentation
     description: IndexResponseBody result type (default view)
     example:
-      api: Consequatur qui est ipsam provident omnis corporis.
-      documentation: Incidunt voluptas deserunt rem sapiente.
+      api: templates
+      documentation: https://templates.keboola.com/v1/documentation
+    required:
+    - api
+    - documentation

api/templates/gen/openapi3.json

@@ -0,0 +1 @@
+{"openapi":"3.0.3","info":{"title":"Templates Service","description":"A service for applying templates to Keboola projects","version":"1.0"},"servers":[{"url":"https://templates.{stack}","variables":{"stack":{"enum":["keboola.com","eu-central-1.keboola.com","north-europe.azure.keboola.com"],"default":"keboola.com"}}}],"paths":{"/":{"get":{"tags":["templates"],"summary":"index-root templates","operationId":"templates#index-root","responses":{"307":{"description":"Temporary Redirect response."}}}},"/v1":{"get":{"tags":["templates"],"summary":"index templates","operationId":"templates#index","responses":{"200":{"description":"OK response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Index"},"example":{"api":"templates","documentation":"https://templates.keboola.com/v1/documentation"}}}}}}},"/v1/health-check":{"get":{"tags":["templates"],"summary":"health-check templates","operationId":"templates#health-check","responses":{"200":{"description":"OK response."}}}}},"components":{"schemas":{"Index":{"type":"object","properties":{"api":{"type":"string","description":"Name of the API","example":"templates"},"documentation":{"type":"string","description":"Url of the API documentation","example":"https://templates.keboola.com/v1/documentation"}},"example":{"api":"templates","documentation":"https://templates.keboola.com/v1/documentation"},"required":["api","documentation"]}}},"tags":[{"name":"templates","description":"Service for applying templates to Keboola projects"}]}

api/openapi3.yaml → api/templates/gen/openapi3.yaml

@@ -4,9 +4,25 @@ info:
   description: A service for applying templates to Keboola projects
   version: "1.0"
 servers:
-- url: http://localhost:8000
+- url: https://templates.{stack}
+  variables:
+    stack:
+      enum:
+      - keboola.com
+      - eu-central-1.keboola.com
+      - north-europe.azure.keboola.com
+      default: keboola.com
 paths:
   /:
+    get:
+      tags:
+      - templates
+      summary: index-root templates
+      operationId: templates#index-root
+      responses:
+        "307":
+          description: Temporary Redirect response.
+  /v1:
     get:
       tags:
       - templates
@@ -20,9 +36,9 @@ paths:
               schema:
                 $ref: '#/components/schemas/Index'
               example:
-                api: Corrupti nisi cumque.
-                documentation: Est aliquid nihil praesentium similique autem.
-  /health-check:
+                api: templates
+                documentation: https://templates.keboola.com/v1/documentation
+  /v1/health-check:
     get:
       tags:
       - templates
@@ -31,29 +47,25 @@ paths:
       responses:
         "200":
           description: OK response.
-  /openapi.json:
-    get:
-      tags:
-      - templates
-      summary: Download ./gen/http/openapi.json
-      operationId: templates#/openapi.json
-      responses:
-        "200":
-          description: File downloaded
 components:
   schemas:
     Index:
       type: object
       properties:
         api:
           type: string
-          example: Exercitationem assumenda quo quidem sapiente harum consequuntur.
+          description: Name of the API
+          example: templates
         documentation:
           type: string
-          example: Sed dolores sunt dolorem.
+          description: Url of the API documentation
+          example: https://templates.keboola.com/v1/documentation
       example:
-        api: Quas voluptatum.
-        documentation: Eius adipisci possimus dicta.
+        api: templates
+        documentation: https://templates.keboola.com/v1/documentation
+      required:
+      - api
+      - documentation
 tags:
 - name: templates
   description: Service for applying templates to Keboola projects

cmd/templates/http.go

@@ -53,7 +53,7 @@ func handleHTTPServer(ctx context.Context, u *url.URL, templatesEndpoints *templ
 	)
 	{
 		eh := errorHandler(logger)
-		templatesServer = templatesSvr.New(templatesEndpoints, mux, dec, enc, eh, nil, nil)
+		templatesServer = templatesSvr.New(templatesEndpoints, mux, dec, enc, eh, nil)
 		if debug {
 			servers := goaHTTP.Servers{
 				templatesServer,

cmd/templates/main.go

@@ -72,7 +72,7 @@ func main() {
 	switch *hostF {
 	case "localhost":
 		{
-			addr := "http://localhost:80"
+			addr := "http://localhost:8000"
 			u, err := url.Parse(addr)
 			if err != nil {
 				fmt.Fprintf(os.Stderr, "invalid URL %#v: %s\n", addr, err)

docs/DEVELOPMENT.md

@@ -69,8 +69,8 @@ API development uses [Goa code generator](https://goa.design/).
 
 When you add REST endpoints or change their behavior:
 
-1. Change the API design first in the [design folder](../design)
-2. Generate the code by running `make api-generate`
+1. Change the API design first in the [api/templates/design.go](../api/templates/design.go)
+2. Generate the code by running `bash scripts/generate-api.sh`
 3. Implement the interfaces generated to [internal/pkg/template/api/gen/templates/service.go](../internal/pkg/template/api/gen/templates/service.go) (The service implementation is then referenced from the [cmd/templates/main.go](../cmd/templates/main.go))
 
 To run the API locally run `docker-compose run --service-ports api`. The API is exposed to http://localhost:8000/