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
This commit is contained in:
parent
bc8d72666c
commit
619b9b5547
17 changed files with 166 additions and 192 deletions
|
@ -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)
|
||||
|
|
19
routers/api/v1/misc/swagger.go
Normal file
19
routers/api/v1/misc/swagger.go
Normal file
|
@ -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)
|
||||
}
|
|
@ -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
|
||||
|
|
|
@ -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")
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue