// Copyright 2021 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package openapi
import (
"bytes"
"html/template"
)
const (
defaultSwaggerHost = "https://petstore3.swagger.io"
swaggerUITemplate = `
API documentation
`
)
// SwaggerConfig configures the SwaggerDoc middlewares.
type SwaggerConfig struct {
// SpecJsonPath the url to find the spec
SpecJSONPath string
// SwaggerHost for the js that generates the swagger ui site, defaults to: http://petstore3.swagger.io/
SwaggerHost string
}
// NewSwaggerConfig return swaggerConfig.
func NewSwaggerConfig(specJSONPath, swaggerHost string) *SwaggerConfig {
if swaggerHost == "" {
swaggerHost = defaultSwaggerHost
}
return &SwaggerConfig{
SpecJSONPath: specJSONPath,
SwaggerHost: swaggerHost,
}
}
// GetSwaggerHTML returns the swagger ui html.
func GetSwaggerHTML(config *SwaggerConfig) (html string, err error) {
tmpl, err := template.New("swaggerdoc").Parse(swaggerUITemplate)
if err != nil {
return
}
buf := bytes.NewBuffer(nil)
err = tmpl.Execute(buf, config)
if err != nil {
return
}
return buf.String(), nil
}