peridot/vendor/github.com/emicklei/go-restful/v3
Mustafa Gezen ad0f7a5305
Major upgrades
Upgrade to Go 1.20.5, Hydra v2 SDK, rules-go v0.44.2 (with proper resolves), protobuf v25.3 and mass upgrade of Go dependencies.
2024-03-17 08:06:08 +01:00
..
log Major upgrades 2024-03-17 08:06:08 +01:00
.gitignore Major upgrades 2024-03-17 08:06:08 +01:00
.goconvey Major upgrades 2024-03-17 08:06:08 +01:00
.travis.yml Major upgrades 2024-03-17 08:06:08 +01:00
bench_test.sh Major upgrades 2024-03-17 08:06:08 +01:00
BUILD.bazel Major upgrades 2024-03-17 08:06:08 +01:00
CHANGES.md Major upgrades 2024-03-17 08:06:08 +01:00
compress.go Major upgrades 2024-03-17 08:06:08 +01:00
compressor_cache.go Major upgrades 2024-03-17 08:06:08 +01:00
compressor_pools.go Major upgrades 2024-03-17 08:06:08 +01:00
compressors.go Major upgrades 2024-03-17 08:06:08 +01:00
constants.go Major upgrades 2024-03-17 08:06:08 +01:00
container.go Major upgrades 2024-03-17 08:06:08 +01:00
cors_filter.go Major upgrades 2024-03-17 08:06:08 +01:00
coverage.sh Major upgrades 2024-03-17 08:06:08 +01:00
curly_route.go Major upgrades 2024-03-17 08:06:08 +01:00
curly.go Major upgrades 2024-03-17 08:06:08 +01:00
custom_verb.go Major upgrades 2024-03-17 08:06:08 +01:00
doc.go Major upgrades 2024-03-17 08:06:08 +01:00
entity_accessors.go Major upgrades 2024-03-17 08:06:08 +01:00
extensions.go Major upgrades 2024-03-17 08:06:08 +01:00
filter_adapter.go Major upgrades 2024-03-17 08:06:08 +01:00
filter.go Major upgrades 2024-03-17 08:06:08 +01:00
json.go Major upgrades 2024-03-17 08:06:08 +01:00
jsoniter.go Major upgrades 2024-03-17 08:06:08 +01:00
jsr311.go Major upgrades 2024-03-17 08:06:08 +01:00
LICENSE Major upgrades 2024-03-17 08:06:08 +01:00
logger.go Major upgrades 2024-03-17 08:06:08 +01:00
Makefile Major upgrades 2024-03-17 08:06:08 +01:00
mime.go Major upgrades 2024-03-17 08:06:08 +01:00
options_filter.go Major upgrades 2024-03-17 08:06:08 +01:00
parameter.go Major upgrades 2024-03-17 08:06:08 +01:00
path_expression.go Major upgrades 2024-03-17 08:06:08 +01:00
path_processor.go Major upgrades 2024-03-17 08:06:08 +01:00
README.md Major upgrades 2024-03-17 08:06:08 +01:00
request.go Major upgrades 2024-03-17 08:06:08 +01:00
response.go Major upgrades 2024-03-17 08:06:08 +01:00
route_builder.go Major upgrades 2024-03-17 08:06:08 +01:00
route_reader.go Major upgrades 2024-03-17 08:06:08 +01:00
route.go Major upgrades 2024-03-17 08:06:08 +01:00
router.go Major upgrades 2024-03-17 08:06:08 +01:00
SECURITY.md Major upgrades 2024-03-17 08:06:08 +01:00
service_error.go Major upgrades 2024-03-17 08:06:08 +01:00
Srcfile Major upgrades 2024-03-17 08:06:08 +01:00
web_service_container.go Major upgrades 2024-03-17 08:06:08 +01:00
web_service.go Major upgrades 2024-03-17 08:06:08 +01:00

go-restful

package for building REST-style Web Services using Google Go

Build Status Go Report Card GoDoc codecov

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:

  • GET = Retrieve a representation of a resource
  • POST = Create if you are sending content to the server to create a subordinate of the specified resource collection, using some server-side algorithm.
  • PUT = Create if you are sending the full content of the specified resource (URI).
  • PUT = Update if you are updating the full content of the specified resource.
  • DELETE = Delete if you are requesting the server to delete the resource
  • PATCH = Update partial content of a resource
  • OPTIONS = Get information about the communication options for the request URI

Usage

Without Go Modules

All versions up to v2.*.* (on the master) are not supporting Go modules.

import (
	restful "github.com/emicklei/go-restful"
)

Using Go Modules

As of version v3.0.0 (on the v3 branch), this package supports Go modules.

import (
	restful "github.com/emicklei/go-restful/v3"
)

Example

ws := new(restful.WebService)
ws.
	Path("/users").
	Consumes(restful.MIME_XML, restful.MIME_JSON).
	Produces(restful.MIME_JSON, restful.MIME_XML)

ws.Route(ws.GET("/{user-id}").To(u.findUser).
	Doc("get a user").
	Param(ws.PathParameter("user-id", "identifier of the user").DataType("string")).
	Writes(User{}))		
...
	
func (u UserResource) findUser(request *restful.Request, response *restful.Response) {
	id := request.PathParameter("user-id")
	...
}

Full API of a UserResource

Features

  • Routes for request → function mapping with path parameter (e.g. {id} but also prefix_{var} and {var}_suffix) support
  • Configurable router:
    • (default) Fast routing algorithm that allows static elements, google custom method, regular expressions and dynamic parameters in the URL path (e.g. /resource/name:customVerb, /meetings/{id} or /static/{subpath:*})
    • Routing algorithm after JSR311 that is implemented using (but does not accept) regular expressions
  • Request API for reading structs from JSON/XML and accessing parameters (path,query,header)
  • Response API for writing structs to JSON/XML and setting headers
  • Customizable encoding using EntityReaderWriter registration
  • Filters for intercepting the request → response flow on Service or Route level
  • Request-scoped variables using attributes
  • Containers for WebServices on different HTTP endpoints
  • Content encoding (gzip,deflate) of request and response payloads
  • Automatic responses on OPTIONS (using a filter)
  • Automatic CORS request handling (using a filter)
  • API declaration for Swagger UI (go-restful-openapi)
  • Panic recovery to produce HTTP 500, customizable using RecoverHandler(...)
  • Route errors produce HTTP 404/405/406/415 errors, customizable using ServiceErrorHandler(...)
  • Configurable (trace) logging
  • Customizable gzip/deflate readers and writers using CompressorProvider registration
  • Inject your own http.Handler using the HttpMiddlewareHandlerToFilter function

How to customize

There are several hooks to customize the behavior of the go-restful package.

  • Router algorithm
  • Panic recovery
  • JSON decoder
  • Trace logging
  • Compression
  • Encoders for other serializers
  • Use jsoniter by building this package using a build tag, e.g. go build -tags=jsoniter .
  • Use the package variable TrimRightSlashEnabled (default true) to control the behavior of matching routes that end with a slash /

Resources

Type git shortlog -s for a full list of contributors.

© 2012 - 2023, http://ernestmicklei.com. MIT License. Contributions are welcome.