Merge pull request #62 from evrone/refactor/endpoints

evrone · Sep 6, 2021 · 2d9ef89 · 2d9ef89
2 parents 9e7a8fa + 53df608
commit 2d9ef89
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 8 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -128,6 +128,9 @@ issues:
       linters:
         - paralleltest
         - godot
+    - path: internal/controller/http
+      linters:
+        - godot
 
 run:
   skip-dirs:

diff --git a/docs/docs.go b/docs/docs.go
@@ -181,7 +181,7 @@ type swaggerInfo struct {
 var SwaggerInfo = swaggerInfo{
 	Version:     "1.0",
 	Host:        "localhost:8080",
-	BasePath:    "/api/v1",
+	BasePath:    "/v1",
 	Schemes:     []string{},
 	Title:       "Go Clean Template API",
 	Description: "Using a translation service as an example",

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -7,7 +7,7 @@
         "version": "1.0"
     },
     "host": "localhost:8080",
-    "basePath": "/api/v1",
+    "basePath": "/v1",
     "paths": {
         "/translation/do-translate": {
             "post": {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -1,4 +1,4 @@
-basePath: /api/v1
+basePath: /v1
 definitions:
   entity.Translation:
     properties:

diff --git a/integration-test/integration_test.go b/integration-test/integration_test.go
@@ -19,7 +19,7 @@ const (
 	attempts   = 20
 
 	// HTTP REST
-	basePath = "http://" + host + "/api/v1"
+	basePath = "http://" + host + "/v1"
 
 	// RabbitMQ RPC
 	rmqURL            = "amqp://guest:guest@rabbitmq:5672/"

diff --git a/internal/controller/http/v1/router.go b/internal/controller/http/v1/router.go
@@ -20,7 +20,7 @@ import (
 // @description Using a translation service as an example
 // @version     1.0
 // @host        localhost:8080
-// @BasePath    /api/v1
+// @BasePath    /v1
 func NewRouter(handler *gin.Engine, l logger.Interface, t usecase.Translation) {
 	// Options
 	handler.Use(gin.Logger())
@@ -34,7 +34,7 @@ func NewRouter(handler *gin.Engine, l logger.Interface, t usecase.Translation) {
 	handler.GET("/healthz", func(c *gin.Context) { c.Status(http.StatusOK) })
 
 	// Routers
-	h := handler.Group("/api/v1")
+	h := handler.Group("/v1")
 	{
 		newTranslationRoutes(h, t, l)
 	}

diff --git a/internal/controller/http/v1/translation.go b/internal/controller/http/v1/translation.go
@@ -37,7 +37,7 @@ type historyResponse struct {
 // @Produce     json
 // @Success     200 {object} historyResponse
 // @Failure     500 {object} response
-// @Router      /translation/history [get].
+// @Router      /translation/history [get]
 func (r *translationRoutes) history(c *gin.Context) {
 	translations, err := r.t.History(c.Request.Context())
 	if err != nil {
@@ -66,7 +66,7 @@ type doTranslateRequest struct {
 // @Success     200 {object} entity.Translation
 // @Failure     400 {object} response
 // @Failure     500 {object} response
-// @Router      /translation/do-translate [post].
+// @Router      /translation/do-translate [post]
 func (r *translationRoutes) doTranslate(c *gin.Context) {
 	var request doTranslateRequest
 	if err := c.ShouldBindJSON(&request); err != nil {