Skip to content

Commit

Permalink
Update ReadMe (#291)
Browse files Browse the repository at this point in the history
  • Loading branch information
fuddin95 authored Dec 10, 2023
1 parent 3b4340f commit aa92a0a
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,32 @@ Demo project tree, `swag init` is run at relative `.`
├── go.sum
└── main.go
```
## Project with Nested Directory
```
.
├── cmd
│   └── ginsimple
│   └── main.go
├── docs
│   ├── docs.go
│   ├── swagger.json
│   └── swagger.yaml
├── go.mod
├── go.sum
└── internal
├── handlers
│   ├── helloWorld.go
│   └── userHandler.go
└── models
├── profile.go
└── user.go
```
Inorder generate swagger docs for projects with nested directories run the following command
```bash
swag init -g ./cmd/ginsimple/main.go -o cmd/docs
```
`-o` will set the auto generated file to the specified path


## Multiple APIs

Expand Down

0 comments on commit aa92a0a

Please sign in to comment.