feat: add tags example (#101)

* add tags example * add format func
swaggo · Apr 22, 2018 · e5d83e9 · e5d83e9
1 parent 7abef30
commit e5d83e9
Show file tree

Hide file tree

Showing 8 changed files with 141 additions and 2 deletions.
diff --git a/example/basic/docs/docs.go b/example/basic/docs/docs.go
@@ -1,6 +1,6 @@
 // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
 // This file was generated by swaggo/swag at
-// 2018-04-12 11:40:37.756883272 +0800 CST m=+0.033069507
+// 2018-04-14 12:21:15.695519809 +0900 JST m=+0.026253845
 
 package docs
 

diff --git a/example/celler/controller/accounts.go b/example/celler/controller/accounts.go
@@ -13,6 +13,7 @@ import (
 // ShowAccount godoc
 // @Summary Show a account
 // @Description get string by ID
+// @Tags accounts
 // @Accept  json
 // @Produce  json
 // @Param id path int true "Account ID"
@@ -39,9 +40,10 @@ func (c *Controller) ShowAccount(ctx *gin.Context) {
 // ListAccounts godoc
 // @Summary List accounts
 // @Description get accounts
+// @Tags accounts
 // @Accept  json
 // @Produce  json
-// @Param q query string false "name search by q"
+// @Param q query string false "name search by q" Format(email)
 // @Success 200 {array} model.Account
 // @Failure 400 {object} httputil.HTTPError
 // @Failure 404 {object} httputil.HTTPError
@@ -60,6 +62,7 @@ func (c *Controller) ListAccounts(ctx *gin.Context) {
 // AddAccount godoc
 // @Summary Add a account
 // @Description add by json account
+// @Tags accounts
 // @Accept  json
 // @Produce  json
 // @Param account body model.AddAccount true "Add account"
@@ -93,6 +96,7 @@ func (c *Controller) AddAccount(ctx *gin.Context) {
 // UpdateAccount godoc
 // @Summary Update a account
 // @Description Update by json account
+// @Tags accounts
 // @Accept  json
 // @Produce  json
 // @Param  id path int true "Account ID"
@@ -129,6 +133,7 @@ func (c *Controller) UpdateAccount(ctx *gin.Context) {
 // DeleteAccount godoc
 // @Summary Update a account
 // @Description Delete by account ID
+// @Tags accounts
 // @Accept  json
 // @Produce  json
 // @Param  id path int true "Account ID" Format(int64)
@@ -155,6 +160,7 @@ func (c *Controller) DeleteAccount(ctx *gin.Context) {
 // UploadAccountImage godoc
 // @Summary Upload account image
 // @Description Upload file
+// @Tags accounts
 // @Accept  multipart/form-data
 // @Produce  json
 // @Param  id path int true "Account ID"

diff --git a/example/celler/controller/admin.go b/example/celler/controller/admin.go
@@ -13,6 +13,7 @@ import (
 // Auth godoc
 // @Summary Auth admin
 // @Description get admin info
+// @Tags accounts,admin
 // @Accept  json
 // @Produce  json
 // @Success 200 {object} model.Admin

diff --git a/example/celler/controller/bottles.go b/example/celler/controller/bottles.go
@@ -13,6 +13,7 @@ import (
 // @Summary Show a bottle
 // @Description get string by ID
 // @ID get-string-by-int
+// @Tags bottles
 // @Accept  json
 // @Produce  json
 // @Param  id path int true "Bottle ID"
@@ -39,6 +40,7 @@ func (c *Controller) ShowBottle(ctx *gin.Context) {
 // ListBottles godoc
 // @Summary List bottles
 // @Description get bottles
+// @Tags bottles
 // @Accept  json
 // @Produce  json
 // @Success 200 {array} model.Bottle

diff --git a/example/celler/controller/examples.go b/example/celler/controller/examples.go
@@ -12,6 +12,7 @@ import (
 // PingExample godoc
 // @Summary ping example
 // @Description do ping
+// @Tags example
 // @Accept json
 // @Produce json
 // @Success 200 {string} string "pong"
@@ -27,6 +28,7 @@ func (c *Controller) PingExample(ctx *gin.Context) {
 // CalcExample godoc
 // @Summary calc example
 // @Description plus
+// @Tags example
 // @Accept json
 // @Produce json
 // @Param val1 query int true "used for calc"
@@ -54,6 +56,7 @@ func (c *Controller) CalcExample(ctx *gin.Context) {
 // PathParamsExample godoc
 // @Summary path params example
 // @Description path params
+// @Tags example
 // @Accept json
 // @Produce json
 // @Param group_id path int true "Group ID"
@@ -80,6 +83,7 @@ func (c *Controller) PathParamsExample(ctx *gin.Context) {
 // HeaderExample godoc
 // @Summary custome header example
 // @Description custome header
+// @Tags example
 // @Accept json
 // @Produce json
 // @Param Authorization header string true "Authentication header"
@@ -95,6 +99,7 @@ func (c *Controller) HeaderExample(ctx *gin.Context) {
 // SecuritiesExample godoc
 // @Summary custome header example
 // @Description custome header
+// @Tags example
 // @Accept json
 // @Produce json
 // @Param Authorization header string true "Authentication header"
@@ -111,6 +116,7 @@ func (c *Controller) SecuritiesExample(ctx *gin.Context) {
 // AttributeExample godoc
 // @Summary attribute example
 // @Description attribute
+// @Tags example
 // @Accept json
 // @Produce json
 // @Param enumstring query string false "string enums" Enums(A, B, C)

diff --git a/example/celler/docs/docs.go b/example/celler/docs/docs.go
@@ -1,5 +1,6 @@
 // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
 // This file was generated by swaggo/swag at
+
 // 2018-04-20 08:32:32.14347006 +0900 JST m=+0.053749461
 
 package docs
@@ -37,6 +38,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "accounts"
+                ],
                 "summary": "List accounts",
                 "parameters": [
                     {
@@ -88,6 +92,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "accounts"
+                ],
                 "summary": "Add a account",
                 "parameters": [
                     {
@@ -142,6 +149,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "accounts"
+                ],
                 "summary": "Show a account",
                 "parameters": [
                     {
@@ -191,6 +201,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "accounts"
+                ],
                 "summary": "Update a account",
                 "parameters": [
                     {
@@ -241,6 +254,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "accounts"
+                ],
                 "summary": "Update a account",
                 "parameters": [
                     {
@@ -302,6 +318,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "accounts"
+                ],
                 "summary": "Upload account image",
                 "parameters": [
                     {
@@ -365,6 +384,10 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "accounts",
+                    "admin"
+                ],
                 "summary": "Auth admin",
                 "responses": {
                     "200": {
@@ -414,6 +437,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "bottles"
+                ],
                 "summary": "List bottles",
                 "responses": {
                     "200": {
@@ -458,6 +484,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "bottles"
+                ],
                 "summary": "Show a bottle",
                 "operationId": "get-string-by-int",
                 "parameters": [
@@ -510,6 +539,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "example"
+                ],
                 "summary": "attribute example",
                 "parameters": [
                     {
@@ -606,6 +638,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "example"
+                ],
                 "summary": "calc example",
                 "parameters": [
                     {
@@ -660,6 +695,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "example"
+                ],
                 "summary": "path params example",
                 "parameters": [
                     {
@@ -714,6 +752,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "example"
+                ],
                 "summary": "custome header example",
                 "parameters": [
                     {
@@ -761,6 +802,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "example"
+                ],
                 "summary": "ping example",
                 "responses": {
                     "200": {
@@ -810,6 +854,9 @@ var doc = `{
                 "produces": [
                     "application/json"
                 ],
+                "tags": [
+                    "example"
+                ],
                 "summary": "custome header example",
                 "parameters": [
                     {