tree: 4ab5d5963f4656ff6606fad04a26eac20e95f3d7 [path history] [tgz]
  1. .gitignore
  2. .travis.yml
  5. Makefile
  7. Srcfile
  9. compress.go
  10. compressor_cache.go
  11. compressor_pools.go
  12. compressors.go
  13. constants.go
  14. container.go
  15. cors_filter.go
  17. curly.go
  18. curly_route.go
  19. doc.go
  20. entity_accessors.go
  21. filter.go
  22. json.go
  23. jsoniter.go
  24. jsr311.go
  25. log/
  26. logger.go
  27. mime.go
  28. options_filter.go
  29. parameter.go
  30. path_expression.go
  31. path_processor.go
  32. request.go
  33. response.go
  34. route.go
  35. route_builder.go
  36. router.go
  37. service_error.go
  38. web_service.go
  39. web_service_container.go


package for building REST-style Web Services using Google Go

Build Status Go Report Card GoDoc

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


ws := new(restful.WebService)
	Consumes(restful.MIME_XML, restful.MIME_JSON).
	Produces(restful.MIME_JSON, restful.MIME_XML)

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

Full API of a UserResource


  • Routes for request → function mapping with path parameter (e.g. {id}) support
  • Configurable router:
    • (default) Fast routing algorithm that allows static elements, regular expressions and dynamic parameters in the URL path (e.g. /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 accesing 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, see go-restful-swagger12)
  • 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

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 build this package using a tag, e.g. go build -tags=jsoniter .

TODO: write examples of these.


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

© 2012 - 2018, MIT License. Contributions are welcome.