airship/kubernetes-entrypoint
Code Issues Proposed changes
b573aa443d
kubernetes-entrypoint/vendor/github.com/emicklei/go-restful
History
pprokop 1344f6314e Changing k8s-client to kubernetes/go-client
2016-11-04 12:41:18 +01:00
..
log Vendor dependencies 2016-10-12 15:00:05 +02:00
swagger Changing k8s-client to kubernetes/go-client 2016-11-04 12:41:18 +01:00
.gitignore Vendor dependencies 2016-10-12 15:00:05 +02:00
bench_test.sh Vendor dependencies 2016-10-12 15:00:05 +02:00
CHANGES.md Vendor dependencies 2016-10-12 15:00:05 +02:00
compress.go Vendor dependencies 2016-10-12 15:00:05 +02:00
compressor_cache.go Vendor dependencies 2016-10-12 15:00:05 +02:00
compressor_pools.go Vendor dependencies 2016-10-12 15:00:05 +02:00
compressors.go Vendor dependencies 2016-10-12 15:00:05 +02:00
constants.go Vendor dependencies 2016-10-12 15:00:05 +02:00
container.go Vendor dependencies 2016-10-12 15:00:05 +02:00
cors_filter.go Vendor dependencies 2016-10-12 15:00:05 +02:00
coverage.sh Vendor dependencies 2016-10-12 15:00:05 +02:00
curly_route.go Vendor dependencies 2016-10-12 15:00:05 +02:00
curly.go Vendor dependencies 2016-10-12 15:00:05 +02:00
doc.go Vendor dependencies 2016-10-12 15:00:05 +02:00
entity_accessors.go Vendor dependencies 2016-10-12 15:00:05 +02:00
filter.go Vendor dependencies 2016-10-12 15:00:05 +02:00
install.sh Vendor dependencies 2016-10-12 15:00:05 +02:00
jsr311.go Vendor dependencies 2016-10-12 15:00:05 +02:00
LICENSE Vendor dependencies 2016-10-12 15:00:05 +02:00
logger.go Vendor dependencies 2016-10-12 15:00:05 +02:00
mime.go Vendor dependencies 2016-10-12 15:00:05 +02:00
options_filter.go Vendor dependencies 2016-10-12 15:00:05 +02:00
parameter.go Vendor dependencies 2016-10-12 15:00:05 +02:00
path_expression.go Vendor dependencies 2016-10-12 15:00:05 +02:00
README.md Vendor dependencies 2016-10-12 15:00:05 +02:00
request.go Vendor dependencies 2016-10-12 15:00:05 +02:00
response.go Vendor dependencies 2016-10-12 15:00:05 +02:00
route_builder.go Vendor dependencies 2016-10-12 15:00:05 +02:00
route.go Vendor dependencies 2016-10-12 15:00:05 +02:00
router.go Vendor dependencies 2016-10-12 15:00:05 +02:00
service_error.go Vendor dependencies 2016-10-12 15:00:05 +02:00
Srcfile Vendor dependencies 2016-10-12 15:00:05 +02:00
web_service_container.go Vendor dependencies 2016-10-12 15:00:05 +02:00
web_service.go Vendor dependencies 2016-10-12 15:00:05 +02:00

README.md

go-restful

package for building REST-style Web Services using Google Go

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

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}) support
  • Configurable router:
    • Routing algorithm after JSR311 that is implemented using (but does not accept) regular expressions (See RouterJSR311 which is used by default)
    • Fast routing algorithm that allows static elements, regular expressions and dynamic parameters in the URL path (e.g. /meetings/{id} or /static/{subpath:*}, See CurlyRouter)
  • Request API for reading structs from JSON/XML and accesing parameters (path,query,header)
  • Response API for writing structs to JSON/XML and setting headers
  • 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 (see swagger package)
  • 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 encoding using EntityReaderWriter registration
  • Customizable gzip/deflate readers and writers using CompressorProvider registration

Resources

Build Status

(c) 2012 - 2015, http://ernestmicklei.com. MIT License

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