THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Browse Source

Swagger.v1.json template (#3572)

* Turn swagger.v1.json into template

* Rename ENABLE_SWAGGER_ENDPOINT option to ENABLE_SWAGGER
tags/v1.6.0-dev
Piotr Orzechowski Lauris BH <lauris@nix.lv> 1 year ago
parent
commit
a74426d631

+ 10
- 3
Makefile View File

@@ -42,6 +42,10 @@ TAGS ?=

TMPDIR := $(shell mktemp -d 2>/dev/null || mktemp -d -t 'gitea-temp')

SWAGGER_SPEC := templates/swagger/v1_json.tmpl
SWAGGER_SPEC_S_TMPL := s|"basePath":\s*"/api/v1"|"basePath": "{{AppSubUrl}}/api/v1"|g
SWAGGER_SPEC_S_JSON := s|"basePath":\s*"{{AppSubUrl}}/api/v1"|"basePath": "/api/v1"|g

TEST_MYSQL_HOST ?= mysql:3306
TEST_MYSQL_DBNAME ?= testgitea
TEST_MYSQL_USERNAME ?= root
@@ -94,11 +98,12 @@ generate-swagger:
@hash swagger > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
$(GO) get -u github.com/go-swagger/go-swagger/cmd/swagger; \
fi
swagger generate spec -o ./public/swagger.v1.json
swagger generate spec -o './$(SWAGGER_SPEC)'
$(SED_INPLACE) '$(SWAGGER_SPEC_S_TMPL)' './$(SWAGGER_SPEC)'

.PHONY: swagger-check
swagger-check: generate-swagger
@diff=$$(git diff public/swagger.v1.json); \
@diff=$$(git diff '$(SWAGGER_SPEC)'); \
if [ -n "$$diff" ]; then \
echo "Please run 'make generate-swagger' and commit the result:"; \
echo "$${diff}"; \
@@ -110,7 +115,9 @@ swagger-validate:
@hash swagger > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
$(GO) get -u github.com/go-swagger/go-swagger/cmd/swagger; \
fi
swagger validate ./public/swagger.v1.json
$(SED_INPLACE) '$(SWAGGER_SPEC_S_JSON)' './$(SWAGGER_SPEC)'
swagger validate './$(SWAGGER_SPEC)'
$(SED_INPLACE) '$(SWAGGER_SPEC_S_TMPL)' './$(SWAGGER_SPEC)'

.PHONY: errcheck
errcheck:

+ 2
- 2
custom/conf/app.ini.sample View File

@@ -581,8 +581,8 @@ DEFAULT_INTERVAL = 8h
MIN_INTERVAL = 10m

[api]
; Enables /api/swagger, /api/v1/swagger etc. endpoints. True or false; default is true.
ENABLE_SWAGGER_ENDPOINT = true
; Enables Swagger. True or false; default is true.
ENABLE_SWAGGER = true
; Max number of items in a page
MAX_RESPONSE_ITEMS = 50


+ 1
- 0
docs/.gitignore View File

@@ -1,2 +1,3 @@
public/
templates/swagger/v1_json.tmpl
themes/

+ 1
- 1
modules/context/context.go View File

@@ -264,7 +264,7 @@ func Contexter() macaron.Handler {
ctx.Data["ShowRegistrationButton"] = setting.Service.ShowRegistrationButton
ctx.Data["ShowFooterBranding"] = setting.ShowFooterBranding
ctx.Data["ShowFooterVersion"] = setting.ShowFooterVersion
ctx.Data["EnableSwaggerEndpoint"] = setting.API.EnableSwaggerEndpoint
ctx.Data["EnableSwagger"] = setting.API.EnableSwagger
ctx.Data["EnableOpenIDSignIn"] = setting.Service.EnableOpenIDSignIn

c.Map(ctx)

+ 4
- 4
modules/setting/setting.go View File

@@ -527,11 +527,11 @@ var (

// API settings
API = struct {
EnableSwaggerEndpoint bool
MaxResponseItems int
EnableSwagger bool
MaxResponseItems int
}{
EnableSwaggerEndpoint: true,
MaxResponseItems: 50,
EnableSwagger: true,
MaxResponseItems: 50,
}

U2F = struct {

+ 14
- 2
modules/templates/dynamic.go View File

@@ -22,8 +22,8 @@ var (
templates = template.New("")
)

// Renderer implements the macaron handler for serving the templates.
func Renderer() macaron.Handler {
// HTMLRenderer implements the macaron handler for serving HTML templates.
func HTMLRenderer() macaron.Handler {
return macaron.Renderer(macaron.RenderOptions{
Funcs: NewFuncMap(),
Directory: path.Join(setting.StaticRootPath, "templates"),
@@ -33,6 +33,18 @@ func Renderer() macaron.Handler {
})
}

// JSONRenderer implements the macaron handler for serving JSON templates.
func JSONRenderer() macaron.Handler {
return macaron.Renderer(macaron.RenderOptions{
Funcs: NewFuncMap(),
Directory: path.Join(setting.StaticRootPath, "templates"),
AppendDirectories: []string{
path.Join(setting.CustomPath, "templates"),
},
HTMLContentType: "application/json",
})
}

// Mailer provides the templates required for sending notification mails.
func Mailer() *template.Template {
for _, funcs := range NewFuncMap() {

+ 18
- 3
modules/templates/static.go View File

@@ -43,8 +43,7 @@ func (templates templateFileSystem) Get(name string) (io.Reader, error) {
return nil, fmt.Errorf("file '%s' not found", name)
}

// Renderer implements the macaron handler for serving the templates.
func Renderer() macaron.Handler {
func NewTemplateFileSystem() templateFileSystem {
fs := templateFileSystem{}
fs.files = make([]macaron.TemplateFile, 0, 10)

@@ -110,9 +109,25 @@ func Renderer() macaron.Handler {
}
}

return fs
}

var tplFileSys = NewTemplateFileSystem()

// HTMLRenderer implements the macaron handler for serving HTML templates.
func HTMLRenderer() macaron.Handler {
return macaron.Renderer(macaron.RenderOptions{
Funcs: NewFuncMap(),
TemplateFileSystem: tplFileSys,
})
}

// JSONRenderer implements the macaron handler for serving JSON templates.
func JSONRenderer() macaron.Handler {
return macaron.Renderer(macaron.RenderOptions{
Funcs: NewFuncMap(),
TemplateFileSystem: fs,
TemplateFileSystem: tplFileSys,
HTMLContentType: "application/json",
})
}


+ 2
- 2
routers/api/v1/api.go View File

@@ -278,13 +278,13 @@ func mustAllowPulls(ctx *context.Context) {
func RegisterRoutes(m *macaron.Macaron) {
bind := binding.Bind

if setting.API.EnableSwaggerEndpoint {
if setting.API.EnableSwagger {
m.Get("/swagger", misc.Swagger) //Render V1 by default
}

m.Group("/v1", func() {
// Miscellaneous
if setting.API.EnableSwaggerEndpoint {
if setting.API.EnableSwagger {
m.Get("/swagger", misc.Swagger)
}
m.Get("/version", misc.Version)

+ 1
- 1
routers/api/v1/misc/swagger.go View File

@@ -10,7 +10,7 @@ import (
)

// tplSwagger swagger page template
const tplSwagger base.TplName = "swagger"
const tplSwagger base.TplName = "swagger/ui"

// Swagger render swagger-ui page with v1 json
func Swagger(ctx *context.Context) {

+ 5
- 1
routers/routes/routes.go View File

@@ -79,7 +79,7 @@ func NewMacaron() *macaron.Macaron {
},
))

m.Use(templates.Renderer())
m.Use(templates.HTMLRenderer())
models.InitMailRender(templates.Mailer())

localeNames, err := options.Dir("locale")
@@ -755,6 +755,10 @@ func RegisterRoutes(m *macaron.Macaron) {
m.Post("/purge", user.NotificationPurgePost)
}, reqSignIn)

if setting.API.EnableSwagger {
m.Get("/swagger.v1.json", templates.JSONRenderer(), routers.SwaggerV1Json)
}

m.Group("/api", func() {
apiv1.RegisterRoutes(m)
}, ignSignIn)

+ 14
- 0
routers/swagger_json.go View File

@@ -0,0 +1,14 @@
package routers

import (
"code.gitea.io/gitea/modules/base"
"code.gitea.io/gitea/modules/context"
)

// tplSwaggerV1Json swagger v1 json template
const tplSwaggerV1Json base.TplName = "swagger/v1_json"

// SwaggerV1Json render swagger v1 json
func SwaggerV1Json(ctx *context.Context) {
ctx.HTML(200, tplSwaggerV1Json)
}

+ 1
- 1
templates/base/footer.tmpl View File

@@ -29,7 +29,7 @@
</div>
</div>
<a href="{{AppSubUrl}}/vendor/librejs.html" data-jslicense="1">JavaScript licenses</a>
{{if .EnableSwaggerEndpoint}}<a href="{{AppSubUrl}}/api/swagger">API</a>{{end}}
{{if .EnableSwagger}}<a href="{{AppSubUrl}}/api/swagger">API</a>{{end}}
<a target="_blank" rel="noopener noreferrer" href="https://gitea.io">{{.i18n.Tr "website"}}</a>
{{if (or .ShowFooterVersion .PageIsAdmin)}}<span class="version">{{GoVer}}</span>{{end}}
</div>

templates/swagger.tmpl → templates/swagger/ui.tmpl View File


public/swagger.v1.json → templates/swagger/v1_json.tmpl View File

@@ -21,7 +21,7 @@
},
"version": "1.1.1"
},
"basePath": "/api/v1",
"basePath": "{{AppSubUrl}}/api/v1",
"paths": {
"/admin/users": {
"post": {

Loading…
Cancel
Save