api/README.md

52 lines
915 B
Markdown
Raw Normal View History

2021-12-19 20:14:07 +03:00
# API
2021-12-19 20:05:02 +03:00
Generic api functions
2021-12-19 20:14:07 +03:00
## Usage
### api.Wrap(handler)
Function Wrap wraps API handler and returns standard http.HandlerFunc. It encapsulate body parsing.
#### Example
```go
package main
import (
"context"
"fmt"
"log"
"net/http"
"github.com/gogeneric/api"
)
func main() {
h := &http.Server{Addr: "0.0.0.0:3000"}
mux := http.NewServeMux()
h.Handler = mux
// Here is magic!
mux.Handle("/hello", api.Wrap(handleHello))
if err := h.ListenAndServe(); err != http.ErrServerClosed {
log.Fatalln(err)
}
}
// Our API handler with custom request and response types
func handleHello(ctx context.Context, req *helloRequest) (*helloResponse, error) {
return &helloResponse{Message: fmt.Sprintf("Hello, %s!", req.Name)}, nil
}
// Custom request type
type helloRequest struct {
Name string `json:"name"`
}
// Custom response type
type helloResponse struct {
Message string `json:"message"`
}
```