summaryrefslogtreecommitdiffstats
path: root/routers/api
diff options
context:
space:
mode:
authorAntoine GIRARD <sapk@users.noreply.github.com>2017-10-21 16:05:50 +0200
committerLunny Xiao <xiaolunwen@gmail.com>2017-10-21 22:05:50 +0800
commit619b9b5547dab4f30acedbf816550df02bb3c1c5 (patch)
tree5a1cfbe2ab2d0723991dac8a8f69b8fe6a98f006 /routers/api
parentbc8d72666c371cc674128011cede929d4ce1ae80 (diff)
downloadgitea-619b9b5547dab4f30acedbf816550df02bb3c1c5.tar.gz
gitea-619b9b5547dab4f30acedbf816550df02bb3c1c5.zip
Move swagger-ui under /api/v1 (#2746)
* Move swagger interface under /api/v1 * Update swagger-ui * Add /api/swagger and prepare for multiple api version * Update test links * Fix footer link
Diffstat (limited to 'routers/api')
-rw-r--r--routers/api/v1/api.go3
-rw-r--r--routers/api/v1/misc/swagger.go19
2 files changed, 22 insertions, 0 deletions
diff --git a/routers/api/v1/api.go b/routers/api/v1/api.go
index 526940493f..1039135440 100644
--- a/routers/api/v1/api.go
+++ b/routers/api/v1/api.go
@@ -275,8 +275,11 @@ func mustAllowPulls(ctx *context.Context) {
func RegisterRoutes(m *macaron.Macaron) {
bind := binding.Bind
+ m.Get("/swagger", misc.Swagger) //Render V1 by default
+
m.Group("/v1", func() {
// Miscellaneous
+ m.Get("/swagger", misc.Swagger)
m.Get("/version", misc.Version)
m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
m.Post("/markdown/raw", misc.MarkdownRaw)
diff --git a/routers/api/v1/misc/swagger.go b/routers/api/v1/misc/swagger.go
new file mode 100644
index 0000000000..0599f85154
--- /dev/null
+++ b/routers/api/v1/misc/swagger.go
@@ -0,0 +1,19 @@
+// Copyright 2017 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package misc
+
+import (
+ "code.gitea.io/gitea/modules/base"
+ "code.gitea.io/gitea/modules/context"
+)
+
+// tplSwagger swagger page template
+const tplSwagger base.TplName = "swagger"
+
+// Swagger render swagger-ui page with v1 json
+func Swagger(ctx *context.Context) {
+ ctx.Data["APIJSONVersion"] = "v1"
+ ctx.HTML(200, tplSwagger)
+}