Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterOpenAPIService ¶
RegisterOpenAPIService adds the WebService that provides the API documentation of all services conform the OpenAPI documentation specifcation.
Types ¶
type Config ¶
type Config struct {
// WebServicesURL is the url where the services are available, e.g. http://localhost:8080
// if left empty then the basePath of Swagger is taken from the actual request
WebServicesURL string
// APIPath is the path where the JSON api is avaiable , e.g. /apidocs
APIPath string
// SwaggerPath [optional] where the swagger UI will be served, e.g. /swagger
SwaggerPath string
// SwaggerFilePath [optional] is the location of folder containing Swagger HTML5 application index.html
SwaggerFilePath string
// api listing is constructed from this list of restful WebServices.
WebServices []*restful.WebService
// will serve all static content (scripts,pages,images)
StaticHandler http.Handler
// [optional] on default CORS (Cross-Origin-Resource-Sharing) is enabled.
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
}
Config holds service api metadata.
type MapModelTypeNameFunc ¶
MapModelTypeNameFunc can be used to return the desired typeName for a given type. It will return false if the default name should be used.
type MapSchemaFormatFunc ¶
MapSchemaFormatFunc can be used to modify typeName at definition time.
Click to show internal directories.
Click to hide internal directories.
