goc_marek/fiber_docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Marek Goc 2023-04-11 22:45:25 +02:00
parent 1ad229d1e2
commit 46a1d9f4f0
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,7 +1,5 @@
# Fiber + Swagger = Fibers
[![deploy](https://git.ma-al.com/goc_marek/fiber_docs/actions/workflows/deploy.yml/badge.svg)](https://git.ma-al.com/goc_marek/fiber_docs/actions/workflows/deploy.yml)
[![Go Reference](https://pkg.go.dev/badge/git.ma-al.com/goc_marek/fiber_docs.svg)](https://pkg.go.dev/git.ma-al.com/goc_marek/fiber_docs)
## Introduction
@ -24,16 +22,17 @@ docs with comment is so stupid. So there is `Fibers`.
## Installation
```shell
go get -u git.ma-al.com/goc_marek/fiber_docs
go get -u github.com/long2ice/fibers
```
## Online Demo
You can see online demo at <https://fibers.long2ice.io/docs> or <https://fibers.long2ice.io/redoc>.
![docs](https://raw.githubusercontent.com/long2ice/fibers/dev/images/docs.png)
![redoc](https://raw.githubusercontent.com/long2ice/fibers/dev/images/redoc.png)
And you can see the code in [examples](https://git.ma-al.com/goc_marek/fiber_docs/tree/dev/examples).
And you can see the code in [examples](https://github.com/long2ice/fibers/tree/dev/examples).
## Usage
@ -46,14 +45,14 @@ package examples
import (
"github.com/getkin/kin-openapi/openapi3"
"git.ma-al.com/goc_marek/fiber_docs/swagger"
"github.com/long2ice/fibers/swagger"
)
func NewSwagger() *swagger.Swagger {
return swagger.New("Fibers", "Swagger + Fiber = Fibers", "0.1.0",
swagger.License(&openapi3.License{
Name: "Apache License 2.0",
URL: "https://git.ma-al.com/goc_marek/fiber_docs/blob/dev/LICENSE",
URL: "https://github.com/long2ice/fibers/blob/dev/LICENSE",
}),
swagger.Contact(&openapi3.Contact{
Name: "long2ice",
@ -197,7 +196,7 @@ package main
import (
"github.com/gin-contrib/cors"
"github.com/gofiber/fiber/v2"
"git.ma-al.com/goc_marek/fiber_docs"
"github.com/long2ice/fibers"
)
func main() {
@ -271,5 +270,5 @@ func main() {
## License
This project is licensed under the
[Apache-2.0](https://git.ma-al.com/goc_marek/fiber_docs/blob/master/LICENSE)
[Apache-2.0](https://github.com/long2ice/fibers/blob/master/LICENSE)
License.