Testing Swagger generation

Author: sapk

routers/api/v1/api.go

@@ -2,6 +2,29 @@
 // Use of this source code is governed by a MIT-style
 // license that can be found in the LICENSE file.
 
+//go:generate swagger generate spec
+
+// Package v1 Gitea API.
+//
+// This provide API interface to communicate with this Gitea instance.
+//
+// Terms Of Service:
+//
+// there are no TOS at this moment, use at your own risk we take no responsibility
+//
+//     Schemes: http, https
+//     BasePath: /api/v1
+//     Version: 1.1.1
+//     License: MIT http://opensource.org/licenses/MIT
+//
+//     Consumes:
+//     - application/json
+//
+//     Produces:
+//     - application/json
+//
+//
+// swagger:meta
 package v1
 
 import (

routers/api/v1/misc/markdown.go

@@ -15,6 +15,24 @@ import (
 // Markdown render markdown document to HTML
 // see https://github.com/gogits/go-gogs-client/wiki/Miscellaneous#render-an-arbitrary-markdown-document
 func Markdown(ctx *context.APIContext, form api.MarkdownOption) {
+	// swagger:route GET /markdown renderMarkdown
+	//
+	// TODO title
+	//
+	// TODO desc
+	//
+	//     Consumes:
+	//     - application/json
+	//
+	//     Produces:
+	//     - text/html
+	//
+	//     Schemes: http, https
+	//
+	//     Responses:
+	//       200: markdownRender
+	//       422: validationError
+
 	if ctx.HasAPIError() {
 		ctx.Error(422, "", ctx.GetErrMsg())
 		return
@@ -42,6 +60,23 @@ func Markdown(ctx *context.APIContext, form api.MarkdownOption) {
 // MarkdownRaw render raw markdown HTML
 // see https://github.com/gogits/go-gogs-client/wiki/Miscellaneous#render-a-markdown-document-in-raw-mode
 func MarkdownRaw(ctx *context.APIContext) {
+	// swagger:route GET /markdown/raw renderMarkdownRaw
+	//
+	// TODO title
+	//
+	// TODO desc
+	//
+	//     Consumes:
+	//     - text/plain
+	//
+	//     Produces:
+	//     - text/html
+	//
+	//     Schemes: http, https
+	//
+	//     Responses:
+	//       200: markdownRawRender
+	//       422: validationError
 	body, err := ctx.Req.Body().Bytes()
 	if err != nil {
 		ctx.Error(422, "", err)

routers/api/v1/misc/version.go

@@ -12,5 +12,19 @@ import (
 
 // Version shows the version of the Gitea server
 func Version(ctx *context.APIContext) {
+
+	// swagger:route GET /version getVersion
+	//
+	// Return Gitea running version.
+	//
+	// This show current running Gitea application version.
+	//
+	//     Produces:
+	//     - application/json
+	//
+	//     Schemes: http, https
+	//
+	//     Responses:
+	//       200: serverVersion
 	ctx.JSON(200, &gitea.ServerVersion{Version: setting.AppVer})
 }