Skip to content

Commit

Permalink
fix(import): adjust import path
Browse files Browse the repository at this point in the history
  • Loading branch information
easonlin404 committed Jul 6, 2017
1 parent ee961b2 commit 27e43b2
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 22 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@

gin middleware to automatically generate RESTful API documentation with Swagger 2.0.

[![Travis branch](https://img.shields.io/travis/swag-gonic/gin-swagger/master.svg)](https://travis-ci.org/swag-gonic/gin-swagger)
[![Codecov branch](https://img.shields.io/codecov/c/github/swag-gonic/gin-swagger/master.svg)](https://codecov.io/gh/swag-gonic/gin-swagger)
[![Go Report Card](https://goreportcard.com/badge/github.com/swag-gonic/gin-swagger)](https://goreportcard.com/report/github.com/swag-gonic/gin-swagger)
[![Travis branch](https://img.shields.io/travis/swaggo/gin-swagger/master.svg)](https://travis-ci.org/swaggo/gin-swagger)
[![Codecov branch](https://img.shields.io/codecov/c/github/swaggo/gin-swagger/master.svg)](https://codecov.io/gh/swaggo/gin-swagger)
[![Go Report Card](https://goreportcard.com/badge/github.com/swaggo/gin-swagger)](https://goreportcard.com/report/github.com/swaggo/gin-swagger)


## Usage

### Start using it
1. Add comments to your API source code, [See Declarative Comments Format](https://github.com/swag-gonic/swag#declarative-comments-format).
2. Download [Swag](https://github.com/swag-gonic/swag) for Go by using:
1. Add comments to your API source code, [See Declarative Comments Format](https://github.com/swaggo/swag#declarative-comments-format).
2. Download [Swag](https://github.com/swaggo/swag) for Go by using:
```sh
$ go get -u github.com/swag-gonic/swag
$ go get -u github.com/swaggo/swag
```

3. Run the [Swag](https://github.com/swag-gonic/swag) in your Go project root folder which contains `main.go` file, [Swag](https://github.com/swag-gonic/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`).
3. Run the [Swag](https://github.com/swaggo/swag) in your Go project root folder which contains `main.go` file, [Swag](https://github.com/swaggo/swag) will parse comments and generate required files(`docs` folder and `docs/doc.go`).
```sh
$ swag init
```
4.Import following in your code:

```go
import "github.com/swag-gonic/gin-swagger" // gin-swagger middleware
import "github.com/swag-gonic/gin-swagger/swaggerFiles" // swagger embed files
import "github.com/swaggo/gin-swagger" // gin-swagger middleware
import "github.com/swaggo/gin-swagger/swaggerFiles" // swagger embed files

```

Expand All @@ -35,10 +35,10 @@ package main

import (
"github.com/gin-gonic/gin"
"github.com/swag-gonic/gin-swagger"
"github.com/swag-gonic/gin-swagger/swaggerFiles"
"github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"

_ "github.com/swag-gonic/gin-swagger/example/docs" // docs is generated by Swag CLI, you have to import it.
_ "github.com/swaggo/gin-swagger/example/docs" // docs is generated by Swag CLI, you have to import it.
)

// @title Swagger Example API
Expand Down
2 changes: 1 addition & 1 deletion example/api/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package api
import (
"fmt"
"github.com/gin-gonic/gin"
"github.com/swag-gonic/swag/example/web"
"github.com/swaggo/swag/example/web"
)

//
Expand Down
4 changes: 2 additions & 2 deletions example/docs/docs.go
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swag-gonic/swag at
// This file was generated by swaggo/swag at
// 2017-06-25 01:25:37.872454531 +0800 CST

package docs

import (
"github.com/swag-gonic/swag/swagger"
"github.com/swaggo/swag/swagger"
)

var doc = `{
Expand Down
6 changes: 3 additions & 3 deletions example/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ package main

import (
"github.com/gin-gonic/gin"
"github.com/swag-gonic/gin-swagger"
"github.com/swag-gonic/gin-swagger/swaggerFiles"
"github.com/swaggo/gin-swagger"
"github.com/swaggo/gin-swagger/swaggerFiles"

_ "github.com/swag-gonic/gin-swagger/example/docs"
_ "github.com/swaggo/gin-swagger/example/docs"
)

// @title Swagger Example API
Expand Down
5 changes: 3 additions & 2 deletions swagger.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package ginSwagger

import (
"github.com/gin-gonic/gin"
"github.com/swag-gonic/swag/swagger"
"github.com/swaggo/swag/swagger"
"golang.org/x/net/webdav"
"html/template"
"regexp"
Expand Down Expand Up @@ -38,7 +38,8 @@ func WrapHandler(h *webdav.Handler) gin.HandlerFunc {
}
index.Execute(c.Writer, s)
case "doc.json":
c.Writer.Write([]byte(swagger.ReadDoc()))
doc, _ := swagger.ReadDoc()
c.Writer.Write([]byte(doc))
return
default:
h.ServeHTTP(c.Writer, c.Request)
Expand Down
4 changes: 2 additions & 2 deletions swagger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ package ginSwagger
import (
"github.com/gin-gonic/gin"
"github.com/stretchr/testify/assert"
"github.com/swag-gonic/gin-swagger/swaggerFiles"
"github.com/swaggo/gin-swagger/swaggerFiles"
"net/http/httptest"
"testing"

_ "github.com/swag-gonic/gin-swagger/example/docs"
_ "github.com/swaggo/gin-swagger/example/docs"
)

func TestWrapHandler(t *testing.T) {
Expand Down

0 comments on commit 27e43b2

Please sign in to comment.