From 27e43b231ee50c15dddd0d4fce57f0c44d7db9d9 Mon Sep 17 00:00:00 2001 From: Eason Lin Date: Fri, 7 Jul 2017 00:57:54 +0800 Subject: [PATCH] fix(import): adjust import path --- README.md | 24 ++++++++++++------------ example/api/api.go | 2 +- example/docs/docs.go | 4 ++-- example/main.go | 6 +++--- swagger.go | 5 +++-- swagger_test.go | 4 ++-- 6 files changed, 23 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 7491def..9d09a33 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 diff --git a/example/api/api.go b/example/api/api.go index 289ba48..241215a 100644 --- a/example/api/api.go +++ b/example/api/api.go @@ -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" ) // diff --git a/example/docs/docs.go b/example/docs/docs.go index 00eed8d..9ded06b 100644 --- a/example/docs/docs.go +++ b/example/docs/docs.go @@ -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 = `{ diff --git a/example/main.go b/example/main.go index 4a02205..17bac13 100644 --- a/example/main.go +++ b/example/main.go @@ -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 diff --git a/swagger.go b/swagger.go index 80edf79..1d6d078 100644 --- a/swagger.go +++ b/swagger.go @@ -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" @@ -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) diff --git a/swagger_test.go b/swagger_test.go index 214444d..07c23bd 100644 --- a/swagger_test.go +++ b/swagger_test.go @@ -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) {