Merge pull request #48 from matsuri-tech/feat/47

feat: endpointsのパスや名前が重複している場合、生成時にエラーを吐かせる

Author: myuon

endpoints.go

@@ -36,6 +36,24 @@ func (e *endpoints) addFrontends(frontends ...string) {
 	e.frontends = append(e.frontends, frontends...)
 }
 
+func (e *endpoints) validate() error {
+	// 重複したnameと、重複したpathとmethodの組み合わせがないかチェック
+	names := map[string]struct{}{}
+	paths := map[string]struct{}{}
+	for _, v := range e.api {
+		if _, ok := names[v.Name]; ok {
+			return fmt.Errorf("duplicate name: %s", v.Name)
+		}
+		names[v.Name] = struct{}{}
+
+		if _, ok := paths[v.Path+v.Method]; ok {
+			return fmt.Errorf("duplicate path and method: %s %s", v.Path, v.Method)
+		}
+		paths[v.Path+v.Method] = struct{}{}
+	}
+	return nil
+}
+
 func (e *endpoints) generateJson() ([]byte, error) {
 	endpoints := orderedmap.New()
 	for _, v := range e.env {
@@ -80,6 +98,10 @@ func (e *endpoints) generateJson() ([]byte, error) {
 }
 
 func (e *endpoints) generate(filename string) error {
+	if err := e.validate(); err != nil {
+		return err
+	}
+
 	bs, err := e.generateJson()
 	if err != nil {
 		return err

endpoints_test.go

@@ -77,7 +77,7 @@ func newRoute(e *echo.Echo) *EchoWrapper {
 		Desc:  "GET samples",
 	})
 	samples.GETTyped("/:id/another", sampleHandler.GetWithQuery, Desc{
-		Name:  "getSamplesWithQuery",
+		Name:  "getSamplesWithQueryAnother",
 		Query: "yearMonth=2021-01",
 		Desc:  "GET samples",
 	}, SampleModel{})
@@ -215,7 +215,7 @@ func TestEchoWrapper_GenerateOpenApi(t *testing.T) {
     "/samples/{id}/another": {
       "get": {
         "description": "GET samples",
-        "operationId": "getSamplesWithQuery",
+        "operationId": "getSamplesWithQueryAnother",
         "parameters": [
           {  
 			"description":"Generated by endpoints-go",
@@ -246,7 +246,7 @@ func TestEchoWrapper_GenerateOpenApi(t *testing.T) {
             "auth": []
           }
         ],
-        "summary": "getSamplesWithQuery"
+        "summary": "getSamplesWithQueryAnother"
       }
     },
     "/samples": {
@@ -295,7 +295,7 @@ func TestEchoWrapper_GenerateOpenApi(t *testing.T) {
   ]
 }`)
 
-	assert.JSONEq(t, string(expected), buf.String(), buf.String())
+	assert.JSONEqf(t, string(expected), buf.String(), buf.String())
 }
 
 func TestEchoWrapper_Generate(t *testing.T) {
@@ -318,6 +318,17 @@ func TestEchoWrapper_Generate(t *testing.T) {
     },
     "api": {
       "getSamplesWithQuery": {
+        "authSchema": {
+          "header": "",
+          "type": ""
+        },
+        "desc": "GET samples",
+        "method": "GET",
+        "path": "samples/:id?yearMonth=2021-01",
+        "request": null,
+        "response": null
+      },
+      "getSamplesWithQueryAnother": {
         "authSchema": {
           "header": "",
           "type": ""
@@ -354,6 +365,17 @@ func TestEchoWrapper_Generate(t *testing.T) {
     },
     "api": {
       "getSamplesWithQuery": {
+        "path": "samples/:id?yearMonth=2021-01",
+        "desc": "GET samples",
+        "method": "GET",
+        "authSchema": {
+          "type": "",
+          "header": ""
+        },
+        "request": null,
+        "response": null
+      },
+      "getSamplesWithQueryAnother": {
         "authSchema": {
           "header": "",
           "type": ""
@@ -467,5 +489,5 @@ func TestEchoWrapper_Generate(t *testing.T) {
   }
 }`)
 
-	assert.JSONEq(t, string(expected), string(actual), string(actual))
+	assert.JSONEqf(t, string(expected), string(actual), string(actual))
 }