123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137 |
- package main
- import (
- "log"
- "net/http"
- "github.com/emicklei/go-restful"
- "github.com/emicklei/go-restful/swagger"
- )
- // This example is functionally the same as the example in restful-user-resource.go
- // with the only difference that is served using the restful.DefaultContainer
- type User struct {
- Id, Name string
- }
- type UserService struct {
- // normally one would use DAO (data access object)
- users map[string]User
- }
- func (u UserService) Register() {
- ws := new(restful.WebService)
- ws.
- Path("/users").
- Consumes(restful.MIME_XML, restful.MIME_JSON).
- Produces(restful.MIME_JSON, restful.MIME_XML) // you can specify this per route as well
- ws.Route(ws.GET("/").To(u.findAllUsers).
- // docs
- Doc("get all users").
- Operation("findAllUsers").
- Returns(200, "OK", []User{}))
- ws.Route(ws.GET("/{user-id}").To(u.findUser).
- // docs
- Doc("get a user").
- Operation("findUser").
- Param(ws.PathParameter("user-id", "identifier of the user").DataType("string")).
- Writes(User{})) // on the response
- ws.Route(ws.PUT("/{user-id}").To(u.updateUser).
- // docs
- Doc("update a user").
- Operation("updateUser").
- Param(ws.PathParameter("user-id", "identifier of the user").DataType("string")).
- Reads(User{})) // from the request
- ws.Route(ws.PUT("").To(u.createUser).
- // docs
- Doc("create a user").
- Operation("createUser").
- Reads(User{})) // from the request
- ws.Route(ws.DELETE("/{user-id}").To(u.removeUser).
- // docs
- Doc("delete a user").
- Operation("removeUser").
- Param(ws.PathParameter("user-id", "identifier of the user").DataType("string")))
- restful.Add(ws)
- }
- // GET http://localhost:8080/users
- //
- func (u UserService) findAllUsers(request *restful.Request, response *restful.Response) {
- response.WriteEntity(u.users)
- }
- // GET http://localhost:8080/users/1
- //
- func (u UserService) findUser(request *restful.Request, response *restful.Response) {
- id := request.PathParameter("user-id")
- usr := u.users[id]
- if len(usr.Id) == 0 {
- response.WriteErrorString(http.StatusNotFound, "User could not be found.")
- } else {
- response.WriteEntity(usr)
- }
- }
- // PUT http://localhost:8080/users/1
- // <User><Id>1</Id><Name>Melissa Raspberry</Name></User>
- //
- func (u *UserService) updateUser(request *restful.Request, response *restful.Response) {
- usr := new(User)
- err := request.ReadEntity(&usr)
- if err == nil {
- u.users[usr.Id] = *usr
- response.WriteEntity(usr)
- } else {
- response.WriteError(http.StatusInternalServerError, err)
- }
- }
- // PUT http://localhost:8080/users/1
- // <User><Id>1</Id><Name>Melissa</Name></User>
- //
- func (u *UserService) createUser(request *restful.Request, response *restful.Response) {
- usr := User{Id: request.PathParameter("user-id")}
- err := request.ReadEntity(&usr)
- if err == nil {
- u.users[usr.Id] = usr
- response.WriteHeaderAndEntity(http.StatusCreated, usr)
- } else {
- response.WriteError(http.StatusInternalServerError, err)
- }
- }
- // DELETE http://localhost:8080/users/1
- //
- func (u *UserService) removeUser(request *restful.Request, response *restful.Response) {
- id := request.PathParameter("user-id")
- delete(u.users, id)
- }
- func main() {
- u := UserService{map[string]User{}}
- u.Register()
- // Optionally, you can install the Swagger Service which provides a nice Web UI on your REST API
- // You need to download the Swagger HTML5 assets and change the FilePath location in the config below.
- // Open http://localhost:8080/apidocs and enter http://localhost:8080/apidocs.json in the api input field.
- config := swagger.Config{
- WebServices: restful.RegisteredWebServices(), // you control what services are visible
- WebServicesUrl: "http://localhost:8080",
- ApiPath: "/apidocs.json",
- // Optionally, specifiy where the UI is located
- SwaggerPath: "/apidocs/",
- SwaggerFilePath: "/Users/emicklei/Projects/swagger-ui/dist"}
- swagger.InstallSwaggerService(config)
- log.Printf("start listening on localhost:8080")
- log.Fatal(http.ListenAndServe(":8080", nil))
- }
|