use callback func to customise, enrich the created Swagger Object.

removes the Info field as this can be set in the callback fund.

Author: Ernest Micklei

config.go

@@ -8,12 +8,18 @@ import (
 )
 
 // MapSchemaFormatFunc can be used to modify typeName at definition time.
+// To use it set the SchemaFormatHandler in the config.
 type MapSchemaFormatFunc func(typeName string) string
 
 // MapModelTypeNameFunc can be used to return the desired typeName for a given
 // type. It will return false if the default name should be used.
+// To use it set the ModelTypeNameHandler in the config.
 type MapModelTypeNameFunc func(t reflect.Type) (string, bool)
 
+// PostBuildSwaggerObjectFunc can be used to change the creates Swagger Object
+// before serving it. To use it set the PostBuildSwaggerObjectHandler in the config.
+type PostBuildSwaggerObjectFunc func(s *spec.Swagger)
+
 // Config holds service api metadata.
 type Config struct {
 	// WebServicesURL is the url where the services are available, e.g. http://localhost:8080
@@ -27,10 +33,10 @@ type Config struct {
 	DisableCORS bool
 	// Top-level API version. Is reflected in the resource listing.
 	APIVersion string
-	// OpenAPI global info struct
-	Info spec.Info
 	// [optional] If set, model builder should call this handler to get addition typename-to-swagger-format-field conversion.
 	SchemaFormatHandler MapSchemaFormatFunc
 	// [optional] If set, model builder should call this handler to retrieve the name for a given type.
 	ModelTypeNameHandler MapModelTypeNameFunc
+	// [optional] If set then call this function with the generated Swagger Object
+	PostBuildSwaggerObjectHandler PostBuildSwaggerObjectFunc
 }

examples/user-resource.go

@@ -121,28 +121,35 @@ func main() {
 		WebServices:    restful.RegisteredWebServices(), // you control what services are visible
 		WebServicesURL: "http://localhost:8080",
 		APIPath:        "/apidocs.json",
-		Info: spec.Info{
-			InfoProps: spec.InfoProps{
-				Title:       "UserService",
-				Description: "Resource for managing Users",
-				Contact: &spec.ContactInfo{
-					Name:  "john",
-					Email: "john@doe.rp",
-					URL:   "http://johndoe.org",
-				},
-				License: &spec.License{
-					Name: "MIT",
-					URL:  "http://mit.org",
-				},
-				Version: "1.0.0",
-			},
-		}}
+		PostBuildSwaggerObjectHandler: enrichSwaggerObject}
 	restfulspec.RegisterOpenAPIService(config, restful.DefaultContainer)
 
 	log.Printf("start listening on localhost:8080")
 	log.Fatal(http.ListenAndServe(":8080", nil))
 }
 
+func enrichSwaggerObject(swo *spec.Swagger) {
+	swo.Info = &spec.Info{
+		InfoProps: spec.InfoProps{
+			Title:       "UserService",
+			Description: "Resource for managing Users",
+			Contact: &spec.ContactInfo{
+				Name:  "john",
+				Email: "john@doe.rp",
+				URL:   "http://johndoe.org",
+			},
+			License: &spec.License{
+				Name: "MIT",
+				URL:  "http://mit.org",
+			},
+			Version: "1.0.0",
+		},
+	}
+	swo.Tags = []spec.Tag{spec.Tag{TagProps: spec.TagProps{
+		Name:        "users",
+		Description: "Managing users"}}}
+}
+
 type User struct {
 	Id, Name string
 }

spec_resource.go

@@ -44,12 +44,14 @@ type specResource struct {
 }
 
 func (s specResource) getSwagger(req *restful.Request, resp *restful.Response) {
-	sw := spec.Swagger{
+	sw := &spec.Swagger{
 		SwaggerProps: spec.SwaggerProps{
-			Info:    &s.config.Info,
 			Swagger: "2.0",
 			Paths:   &(s.paths),
 		},
 	}
+	if s.config.PostBuildSwaggerObjectHandler != nil {
+		s.config.PostBuildSwaggerObjectHandler(sw)
+	}
 	resp.WriteAsJson(sw)
 }