diff options
| author | Antoine GIRARD <sapk@users.noreply.github.com> | 2017-10-21 16:05:50 +0200 |
|---|---|---|
| committer | Lunny Xiao <xiaolunwen@gmail.com> | 2017-10-21 22:05:50 +0800 |
| commit | 619b9b5547dab4f30acedbf816550df02bb3c1c5 (patch) | |
| tree | 5a1cfbe2ab2d0723991dac8a8f69b8fe6a98f006 /routers | |
| parent | bc8d72666c371cc674128011cede929d4ce1ae80 (diff) | |
| download | gitea-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')
| -rw-r--r-- | routers/api/v1/api.go | 3 | ||||
| -rw-r--r-- | routers/api/v1/misc/swagger.go | 19 | ||||
| -rw-r--r-- | routers/home.go | 7 | ||||
| -rw-r--r-- | routers/routes/routes.go | 1 |
4 files changed, 22 insertions, 8 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) +} diff --git a/routers/home.go b/routers/home.go index cf957c1215..768eb22077 100644 --- a/routers/home.go +++ b/routers/home.go @@ -20,8 +20,6 @@ import ( const ( // tplHome home page template tplHome base.TplName = "home" - // tplSwagger swagger page template - tplSwagger base.TplName = "swagger" // tplExploreRepos explore repositories page template tplExploreRepos base.TplName = "explore/repos" // tplExploreUsers explore users page template @@ -53,11 +51,6 @@ func Home(ctx *context.Context) { ctx.HTML(200, tplHome) } -// Swagger render swagger-ui page -func Swagger(ctx *context.Context) { - ctx.HTML(200, tplSwagger) -} - // RepoSearchOptions when calling search repositories type RepoSearchOptions struct { OwnerID int64 diff --git a/routers/routes/routes.go b/routers/routes/routes.go index 749f8263f8..46521130f8 100644 --- a/routers/routes/routes.go +++ b/routers/routes/routes.go @@ -160,7 +160,6 @@ func RegisterRoutes(m *macaron.Macaron) { return "" }) m.Get("/", ignSignIn, routers.Home) - m.Get("/swagger", ignSignIn, routers.Swagger) m.Group("/explore", func() { m.Get("", func(ctx *context.Context) { ctx.Redirect(setting.AppSubURL + "/explore/repos") |