Merge pull request #26 from RussellLuo/multi-http-ops

annotation: Add support for multiple HTTP operations

README.md

@@ -316,6 +316,10 @@ See more examples [here](examples).
 //kun:op <method> <pattern>
 ```
 
+If a Go method needs to correspond to more than one URI (or HTTP method), you can specify multiple `//kun:op` directives, which will produce multiple HTTP request operations.
+
+Note that the only differences among these HTTP request operations are the path parameters.
+
 ##### Arguments
 
 - **method**: The request method.
@@ -324,15 +328,33 @@ See more examples [here](examples).
     
 ##### Examples
 
-```go
-type Service interface {
-    //kun:op DELETE /users/{id}
-    DeleteUser(ctx context.Context, id int) (err error)
-}
+- Single operation:
 
-// HTTP request:
-// $ http DELETE /users/101
-```
+    ```go
+    type Service interface {
+        //kun:op DELETE /users/{id}
+        DeleteUser(ctx context.Context, id int) (err error)
+    }
+
+    // HTTP request:
+    // $ http DELETE /users/101
+    ```
+
+- Multiple operations:
+
+    ```go
+    type Service interface {
+        //kun:op GET /messages/{messageID}
+        //kun:op GET /users/{userID}/messages/{messageID}
+        GetMessage(ctx context.Context, userID string, messageID string) (text string, err error)
+    }
+  
+    // See a runnable example in examples/messaging.
+
+    // HTTP request:
+    // $ http GET /messages/123456
+    // $ http GET /users/me/messages/123456
+    ```
 
 </details>
 

examples/messaging/README.md

@@ -0,0 +1,33 @@
+# messaging
+
+This example illustrates how to specify multiple HTTP operations.
+
+
+## Generate the code
+
+```bash
+$ go generate
+```
+
+## Test the server
+
+Run the server:
+
+```bash
+$ go run cmd/main.go
+2022/02/26 17:45:20 transport=HTTP addr=:8080
+```
+
+Get a message:
+
+```bash
+$ curl -XGET 'http://localhost:8080/messages/123456'
+{"text":"user[]: message[123456]"}
+```
+
+Get a message from a specific user:
+
+```bash
+$ curl -XGET 'http://localhost:8080/users/me/messages/123456'
+{"text":"user[me]: message[123456]"}
+```

examples/messaging/cmd/main.go

@@ -0,0 +1,35 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"log"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/RussellLuo/kun/examples/messaging"
+	"github.com/RussellLuo/kun/pkg/httpcodec"
+)
+
+func main() {
+	httpAddr := flag.String("http.addr", ":8080", "HTTP listen address")
+	flag.Parse()
+
+	svc := &messaging.Messaging{}
+	r := messaging.NewHTTPRouter(svc, httpcodec.NewDefaultCodecs(nil))
+
+	errs := make(chan error, 2)
+	go func() {
+		log.Printf("transport=HTTP addr=%s\n", *httpAddr)
+		errs <- http.ListenAndServe(*httpAddr, r)
+	}()
+	go func() {
+		c := make(chan os.Signal, 1)
+		signal.Notify(c, syscall.SIGINT, syscall.SIGTERM)
+		errs <- fmt.Errorf("%s", <-c)
+	}()
+
+	log.Printf("terminated, err:%v", <-errs)
+}