init v1.0.0

Author: chengjin

.gitignore

@@ -0,0 +1,16 @@
+# Binaries for programs and plugins
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+dist
+
+.idea
+vendor
+.envrc

.goreleaser.yml

@@ -0,0 +1,10 @@
+builds:
+  - skip: true
+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+**Describe the PR**
+e.g. add cool parser.
+
+**Relation issue**
+e.g. https://github.com/swaggo/fasthttp-swagger/pull/123/files
+
+**Additional context**
+Add any other context about the problem here.

README.md

@@ -0,0 +1,140 @@
+# fasthttp-swagger
+
+gin middleware to automatically generate RESTFUL API documentation with Swagger 2.0.
+
+[![Build Status](https://github.com/swaggo/fasthttp-swagger/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/features/actions)
+[![Codecov branch](https://img.shields.io/codecov/c/github/swaggo/fasthttp-swagger/master.svg)](https://codecov.io/gh/swaggo/fasthttp-swagger)
+[![Go Report Card](https://goreportcard.com/badge/github.com/swaggo/fasthttp-swagger)](https://goreportcard.com/report/github.com/swaggo/fasthttp-swagger)
+[![GoDoc](https://godoc.org/github.com/swaggo/fasthttp-swagger?status.svg)](https://godoc.org/github.com/swaggo/fasthttp-swagger)
+[![Release](https://img.shields.io/github/release/swaggo/fasthttp-swagger.svg?style=flat-square)](https://github.com/swaggo/fasthttp-swagger/releases)
+
+## Usage
+
+### Start using it
+
+1. Add comments to your API source code, [See Declarative Comments Format](https://swaggo.github.io/swaggo.io/declarative_comments_format/).
+2. Download [Swag](https://github.com/swaggo/swag) for Go by using:
+
+```sh
+go get -u github.com/swaggo/swag/cmd/swag
+```
+
+3. Run the [Swag](https://github.com/swaggo/swag) at your Go project root path(for instance `~/root/go-peoject-name`),
+   [Swag](https://github.com/swaggo/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`)
+   at `~/root/go-peoject-name/docs`.
+
+```sh
+swag init
+```
+
+4. Download [fasthttp-swagger](https://github.com/swaggo/fasthttp-swagger) by using:
+
+```sh
+go get -u github.com/swaggo/fasthttp-swagger
+go get -u github.com/swaggo/files
+```
+
+Import following in your code:
+
+```go
+import "github.com/swaggo/fasthttp-swagger" // fasthttp-swagger middleware
+
+```
+
+### Canonical example:
+
+Now assume you have implemented a simple api as following:
+
+```go
+// A get function which returns a hello world string by json
+func Helloworld(ctx *fasthttp.RequestCtx)  {
+    ctx.SetStatusCode(http.StatusOK)
+    ctx.Write([]byte("helloworld"))
+}
+
+```
+
+So how to use fasthttp-swagger on api above? Just follow the following guide.
+
+1. Add Comments for apis and main function with fasthttp-swagger rules like following:
+
+```go
+// @BasePath /api/v1
+
+// PingExample godoc
+// @Summary ping example
+// @Schemes
+// @Description do ping
+// @Tags example
+// @Accept json
+// @Produce json
+// @Success 200 {string} Helloworld
+// @Router /example/helloworld [get]
+func Helloworld(ctx *fasthttp.RequestCtx)  {
+    ctx.SetStatusCode(http.StatusOK)
+    ctx.Write([]byte("helloworld"))
+}
+```
+
+2. Use `swag init` command to generate a docs, docs generated will be stored at
+3. import the docs like this:
+   I assume your project named `github.com/go-project-name/docs`.
+
+```go
+import (
+   docs "github.com/go-project-name/docs"
+)
+```
+
+4. build your application and after that, go to http://localhost:8080/swagger/index.html ,you to see your Swagger UI.
+
+5. The full code and folder relatives here:
+
+```go
+package main
+
+import (
+   _ "github.com/go-project-name/docs"
+   fasthttpSwagger "github.com/swaggo/fasthttp-swagger"
+)
+// @BasePath /api/v1
+
+// PingExample godoc
+// @Summary ping example
+// @Schemes
+// @Description do ping
+// @Tags example
+// @Accept json
+// @Produce json
+// @Success 200 {string} Helloworld
+// @Router /example/helloworld [get]
+func Helloworld(ctx *fasthttp.RequestCtx)  {
+   ctx.SetStatusCode(http.StatusOK)
+   ctx.Write([]byte("helloworld"))
+}
+
+func main()  {
+   fasthttp.ListenAndServe(":8080", func(ctx *fasthttp.RequestCtx) {
+      path := string(ctx.RequestURI())
+      switch {
+      case strings.HasPrefix(path, "/swagger"):
+         fastHttpSwagger.WrapHandler(fastHttpSwagger.InstanceName("swagger"))(ctx)
+      case path == "/api/v1/example/helloworld":
+         Helloworld(ctx)
+      }
+   })
+}
+```
+
+Demo project tree, `swag init` is run at relative `.`
+
+```
+.
+├── docs
+│   ├── docs.go
+│   ├── swagger.json
+│   └── swagger.yaml
+├── go.mod
+├── go.sum
+└── main.go
+```

b0x.yml

@@ -0,0 +1,84 @@
+# all folders and files are relative to the path 
+# where fileb0x was run at!
+
+# default: main
+pkg: swaggerFiles
+
+# destination
+dest: "./swaggerFiles/"
+
+# gofmt
+# type: bool
+# default: false
+fmt: true
+
+# compress files
+# at the moment, only supports gzip
+#
+# type: object
+compression:
+  # activates the compression
+  #
+  # type: bool
+  # default: false
+  compress: false
+
+  # valid values are:
+  # -> "NoCompression"
+  # -> "BestSpeed"
+  # -> "BestCompression"
+  # -> "DefaultCompression" or ""
+  #
+  # type: string
+  # default: "DefaultCompression" # when: Compress == true && Method == ""
+  method: ""
+
+  # true = do it yourself (the file is written as gzip compressed file into the memory file system)
+  # false = decompress files at run time (while writing file into memory file system)
+  #
+  # type: bool
+  # default: false
+  keep: false
+
+# ---------------
+# -- DANGEROUS --
+# ---------------
+# 
+# cleans the destination folder (only b0xfiles)
+# you should use this when using the spread function
+# type: bool
+# default: false
+clean: true
+
+# default: ab0x.go
+output: "ab0x.go"
+
+# [unexporTed] builds non-exporTed functions, variables and types...
+# type: bool
+# default: false
+unexporTed: false
+
+# [spread] means it will make a file to hold all fileb0x data
+# and each file into a separaTed .go file
+#
+# example:
+# theres 2 files in the folder assets, they're: hello.json and world.txt
+# when spread is activaTed, fileb0x will make a file: 
+# b0x.go or [output]'s data, assets_hello.json.go and assets_world.txt.go
+#
+#
+# type: bool
+# default: false
+spread: true
+
+# type: array of objects
+custom:
+
+  - files:
+    # everything inside the folder
+    # type: array of strings
+    - "./dist/"
+
+    # base is the path that will be removed from all files' path
+    # type: string
+    base: "dist"

example/basic/api/api.go

@@ -0,0 +1,39 @@
+package api
+
+import (
+	"fmt"
+	"github.com/swaggo/swag/example/basic/web"
+	"github.com/valyala/fasthttp"
+)
+
+// @Summary Add a new pet to the store
+// @Description get string by ID
+// @Accept  json
+// @Produce  json
+// @Param   some_id     path    int     true        "Some ID"
+// @Success 200 {string} string	"ok"
+// @Failure 400 {object} web.APIError "We need ID!!"
+// @Failure 404 {object} web.APIError "Can not find ID"
+// @Router /testapi/get-string-by-int/{some_id} [get]
+func GetStringByInt(ctx *fasthttp.RequestCtx) {
+	err := web.APIError{}
+	fmt.Println(err)
+}
+
+// @Description get struct array by ID
+// @Accept  json
+// @Produce  json
+// @Param   some_id     path    string     true        "Some ID"
+// @Param   offset     query    int     true        "Offset"
+// @Param   limit      query    int     true        "Offset"
+// @Success 200 {string} string	"ok"
+// @Failure 400 {object} web.APIError "We need ID!!"
+// @Failure 404 {object} web.APIError "Can not find ID"
+// @Router /testapi/get-struct-array-by-string/{some_id} [get]
+func GetStructArrayByString(ctx *fasthttp.RequestCtx) {
+
+}
+
+type Pet3 struct {
+	ID int `json:"id"`
+}