examples use v3

emicklei · Oct 23, 2020 · 601692b · 601692b
1 parent a0fdb2a
commit 601692b
Show file tree

Hide file tree

Showing 64 changed files with 332 additions and 153 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,21 +1,21 @@
-# Change history of go-restful
+# Change history of go-restful (v2 only)
 
 
-## [v2.14.3] - 2020-08-31
+## v2.14.3 - 2020-08-31
 - Fixed duplicate compression in dispatch. #449
 
 
-## [v2.14.2] - 2020-08-31
+## v2.14.2 - 2020-08-31
 
 - Added check on writer to prevent compression of response twice. #447
 
-## [v2.14.0] - 2020-08-19
+## v2.14.0 - 2020-08-19
 
 - Enable content encoding on Handle and ServeHTTP (#446)
 - List available representations in 406 body (#437)
 - Convert to string using rune() (#443)
 
-## [v2.13.0] - 2020-06-21
+## v2.13.0 - 2020-06-21
 
 - 405 Method Not Allowed must have Allow header (#436)
 - add field allowedMethodsWithoutContentType (#424)

diff --git a/Makefile b/Makefile
@@ -2,7 +2,4 @@ all: test
 
 test:
 	go vet .
-	go test -cover -v .
-
-ex:
-	cd examples && ls *.go | xargs go build -o /tmp/ignore
+	go test -cover -v .
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ package for building REST-style Web Services using Google Go
 [![GoDoc](https://godoc.org/github.com/emicklei/go-restful?status.svg)](https://pkg.go.dev/github.com/emicklei/go-restful)
 [![codecov](https://codecov.io/gh/emicklei/go-restful/branch/master/graph/badge.svg)](https://codecov.io/gh/emicklei/go-restful)
 
-- [Code examples](/~https://github.com/emicklei/go-restful/tree/master/examples)
+- [Code examples using v3](/~https://github.com/emicklei/go-restful/tree/master/examples)
 
 REST asks developers to use HTTP methods explicitly and in a way that's consistent with the protocol definition. This basic REST design principle establishes a one-to-one mapping between create, read, update, and delete (CRUD) operations and HTTP methods. According to this mapping:
 
@@ -21,23 +21,23 @@ REST asks developers to use HTTP methods explicitly and in a way that's consiste
 
 ### Usage
 
-#### Without Go Modules
+#### Using Go Modules
 
-All versions up to `v2.*.*` (on the master) are not supporting Go modules.
+As of version `v3.0.0` (on the v3 branch), this package supports Go modules.
 
 ```
 import (
-	restful "github.com/emicklei/go-restful"
+	restful "github.com/emicklei/go-restful/v3"
 )
 ```
 
-#### Using Go Modules
+#### Without Go Modules
 
-As of version `v3.0.0` (on the v3 branch), this package supports Go modules.
+All versions up to `v2.*.*` (on the master) are not supporting Go modules.
 
 ```
 import (
-	restful "github.com/emicklei/go-restful/v3"
+	restful "github.com/emicklei/go-restful"
 )
 ```
 

diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1 @@
+## examples use v3 of the package
diff --git a/examples/basicauth/go.mod b/examples/basicauth/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/basicauth
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/basicauth/go.sum b/examples/basicauth/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-basic-authentication.go → ...basicauth/restful-basic-authentication.go b/examples/restful-basic-authentication.go → ...basicauth/restful-basic-authentication.go
@@ -1,10 +1,11 @@
 package main
 
 import (
-	"github.com/emicklei/go-restful"
 	"io"
 	"log"
 	"net/http"
+
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 // This example shows how to create a (Route) Filter that performs Basic Authentication on the Http request.

diff --git a/examples/cors/go.mod b/examples/cors/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/cors
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/cors/go.sum b/examples/cors/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-CORS-filter.go → examples/cors/restful-CORS-filter.go b/examples/restful-CORS-filter.go → examples/cors/restful-CORS-filter.go
@@ -5,7 +5,7 @@ import (
 	"log"
 	"net/http"
 
-	"github.com/emicklei/go-restful"
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 // Cross-origin resource sharing (CORS) is a mechanism that allows JavaScript on a web page

diff --git a/examples/cpuprof/go.mod b/examples/cpuprof/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/cpuprof
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/cpuprof/go.sum b/examples/cpuprof/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-cpuprofiler-service.go → ...es/cpuprof/restful-cpuprofiler-service.go b/examples/restful-cpuprofiler-service.go → ...es/cpuprof/restful-cpuprofiler-service.go
@@ -1,11 +1,12 @@
 package main
 
 import (
-	"github.com/emicklei/go-restful"
 	"io"
 	"log"
 	"os"
 	"runtime/pprof"
+
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 // ProfilingService is a WebService that can start/stop a CPU profile and write results to a file

diff --git a/examples/encoding/go.mod b/examples/encoding/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/encoding
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/encoding/go.sum b/examples/encoding/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-encoding-filter.go → examples/encoding/restful-encoding-filter.go b/examples/restful-encoding-filter.go → examples/encoding/restful-encoding-filter.go
@@ -1,9 +1,10 @@
 package main
 
 import (
-	"github.com/emicklei/go-restful"
 	"log"
 	"net/http"
+
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 type User struct {

diff --git a/examples/filters/go.mod b/examples/filters/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/filters
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/filters/go.sum b/examples/filters/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-filters.go → examples/filters/restful-filters.go b/examples/restful-filters.go → examples/filters/restful-filters.go
@@ -1,10 +1,11 @@
 package main
 
 import (
-	"github.com/emicklei/go-restful"
 	"log"
 	"net/http"
 	"time"
+
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 type User struct {

diff --git a/examples/form/go.mod b/examples/form/go.mod
@@ -0,0 +1,8 @@
+module github.com/emicklei/go-restful/examples/form
+
+go 1.14
+
+require (
+	github.com/emicklei/go-restful/v3 v3.3.3 // indirect
+	github.com/gorilla/schema v1.2.0 // indirect
+)
diff --git a/examples/form/go.sum b/examples/form/go.sum
@@ -0,0 +1,6 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
+github.com/gorilla/schema v1.2.0 h1:YufUaxZYCKGFuAq3c96BOhjgd5nmXiOY9NGzF247Tsc=
+github.com/gorilla/schema v1.2.0/go.mod h1:kgLaKoK1FELgZqMAVxx/5cbj0kT+57qxUrAlIO2eleU=
diff --git a/examples/restful-form-handling.go → examples/form/restful-form-handling.go b/examples/restful-form-handling.go → examples/form/restful-form-handling.go
@@ -2,11 +2,12 @@ package main
 
 import (
 	"fmt"
-	"github.com/emicklei/go-restful"
-	"github.com/gorilla/schema"
 	"io"
 	"log"
 	"net/http"
+
+	restful "github.com/emicklei/go-restful/v3"
+	"github.com/gorilla/schema"
 )
 
 // This example shows how to handle a POST of a HTML form that uses the standard x-www-form-urlencoded content-type.

diff --git a/examples/fulllog/go.mod b/examples/fulllog/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/fulllog
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/fulllog/go.sum b/examples/fulllog/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-full-logging-filter.go → ...es/fulllog/restful-full-logging-filter.go b/examples/restful-full-logging-filter.go → ...es/fulllog/restful-full-logging-filter.go
@@ -6,7 +6,7 @@ import (
 	"log"
 	"net/http"
 
-	"github.com/emicklei/go-restful"
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 type User struct {

diff --git a/examples/google-custom-method/go.mod b/examples/google-custom-method/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/google-custom-method
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/google-custom-method/go.sum b/examples/google-custom-method/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-google-custom-method.go → ...om-method/restful-google-custom-method.go b/examples/restful-google-custom-method.go → ...om-method/restful-google-custom-method.go
@@ -1,10 +1,11 @@
 package main
 
 import (
-	. "github.com/emicklei/go-restful"
 	"io"
 	"log"
 	"net/http"
+
+	. "github.com/emicklei/go-restful/v3"
 )
 
 // This example shows how to create a Route with google custom method

diff --git a/examples/hello/go.mod b/examples/hello/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/hello
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/hello/go.sum b/examples/hello/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-hello-world.go → examples/hello/restful-hello-world.go b/examples/restful-hello-world.go → examples/hello/restful-hello-world.go
@@ -1,10 +1,11 @@
 package main
 
 import (
-	"github.com/emicklei/go-restful"
 	"io"
 	"log"
 	"net/http"
+
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 // This example shows the minimal code needed to get a restful.WebService working.

diff --git a/examples/jwtauth/go.mod b/examples/jwtauth/go.mod
@@ -0,0 +1,8 @@
+module github.com/emicklei/go-restful/examples/jwtauth
+
+go 1.14
+
+require (
+	github.com/dgrijalva/jwt-go v3.2.0+incompatible // indirect
+	github.com/emicklei/go-restful/v3 v3.3.3 // indirect
+)
diff --git a/examples/jwtauth/go.sum b/examples/jwtauth/go.sum
@@ -0,0 +1,7 @@
+github.com/dgrijalva/jwt-go v1.0.2 h1:KPldsxuKGsS2FPWsNeg9ZO18aCrGKujPoWXn2yo+KQM=
+github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM=
+github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-jwt-authentication.go → ...les/jwtauth/restful-jwt-authentication.go b/examples/restful-jwt-authentication.go → ...les/jwtauth/restful-jwt-authentication.go
@@ -1,12 +1,13 @@
 package main
 
 import (
-	"github.com/dgrijalva/jwt-go"
-	"github.com/emicklei/go-restful"
 	"io"
 	"log"
 	"net/http"
 	"strings"
+
+	"github.com/dgrijalva/jwt-go"
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 // This example shows how to create a (Route) Filter that performs a JWT HS512 authentication.

diff --git a/examples/msgpack/msgpack_entity.go b/examples/msgpack/msgpack_entity.go
@@ -1,7 +1,7 @@
 package restPack
 
 import (
-	restful "github.com/emicklei/go-restful"
+	restful "github.com/emicklei/go-restful/v3"
 	"gopkg.in/vmihailenco/msgpack.v2"
 )
 

diff --git a/examples/multi-container/go.mod b/examples/multi-container/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/multi-container
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/multi-container/go.sum b/examples/multi-container/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-multi-containers.go → ...lti-container/restful-multi-containers.go b/examples/restful-multi-containers.go → ...lti-container/restful-multi-containers.go
@@ -1,10 +1,11 @@
 package main
 
 import (
-	"github.com/emicklei/go-restful"
 	"io"
 	"log"
 	"net/http"
+
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 // This example shows how to have a program with 2 WebServices containers

diff --git a/examples/ncsa/go.mod b/examples/ncsa/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/ncsa
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/ncsa/go.sum b/examples/ncsa/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=
diff --git a/examples/restful-NCSA-logging.go → examples/ncsa/restful-NCSA-logging.go b/examples/restful-NCSA-logging.go → examples/ncsa/restful-NCSA-logging.go
@@ -1,13 +1,14 @@
 package main
 
 import (
-	"github.com/emicklei/go-restful"
 	"io"
 	"log"
 	"net/http"
 	"os"
 	"strings"
 	"time"
+
+	restful "github.com/emicklei/go-restful/v3"
 )
 
 // This example shows how to create a filter that produces log lines

diff --git a/examples/nocache/go.mod b/examples/nocache/go.mod
@@ -0,0 +1,5 @@
+module github.com/emicklei/go-restful/examples/nocache
+
+go 1.14
+
+require github.com/emicklei/go-restful/v3 v3.3.3 // indirect
diff --git a/examples/nocache/go.sum b/examples/nocache/go.sum
@@ -0,0 +1,4 @@
+github.com/emicklei/go-restful v1.1.3 h1:KOKLkEASmIa2roa2xEV6WkADqyWrok5dt3TOMMHF1fE=
+github.com/emicklei/go-restful v2.14.3+incompatible h1:i59XyRHAxKCVBw3vHzQlpP/+pi89wH1v1HL+RKyVgxk=
+github.com/emicklei/go-restful/v3 v3.3.3 h1:2WxjFb4b+Eik8vJ1saz3jbhKnt4xaFVn3N9uU3WXfLE=
+github.com/emicklei/go-restful/v3 v3.3.3/go.mod h1:6n3XBCmQQb25CM2LCACGz8ukIrRry+4bhvbpWn3mrbc=