couldn't find a swagger spec #2580

santosh · 2021-05-26T04:12:41Z

Problem statement

Getting couldn't find a swagger spec when doing swagger generate server -A todo-list -f ./swagger.yml.
I am following https://goswagger.io/tutorial/todo-list.html.

Steps to reproduce

Go to https://goswagger.io/tutorial/todo-list.html and copy the complete spec to a file called swagger.yml.
Run swagger generate server -A todo-list -f ./swagger.yml from the directory of the file.

Environment

swagger version: version: v0.27.0
go version: go1.15.8
OS: Amazon Linux 2

The text was updated successfully, but these errors were encountered:

Planck1858 · 2021-05-31T12:46:42Z

Same problem

youyuanwu · 2021-06-01T03:24:03Z

Is couldn't find a swagger spec the entire swagger output in terminal?

santosh · 2021-06-02T05:19:30Z

@youyuanwu yes, correct.

youyuanwu · 2021-06-02T07:15:47Z

Cannot reproduce

bash:~/temp$ ls
swagger.yml
bash:~/temp$ cat swagger.yml 
swagger: "2.0"
info:
  description: From the todo list tutorial on goswagger.io
  title: A Todo list application
  version: 1.0.0
consumes:
- application/io.goswagger.examples.todo-list.v1+json
produces:
- application/io.goswagger.examples.todo-list.v1+json
schemes:
- http
paths:
  /:
    get:
      tags:
        - todos
      parameters:
        - name: since
          in: query
          type: integer
          format: int64
        - name: limit
          in: query
          type: integer
          format: int32
          default: 20
      responses:
        200:
          description: list the todo operations
          schema:
            type: array
            items:
              $ref: "#/definitions/item"
        default:
          description: generic error response
          schema:
            $ref: "#/definitions/error"
definitions:
  item:
    type: object
    required:
      - description
    properties:
      id:
        type: integer
        format: int64
        readOnly: true
      description:
        type: string
        minLength: 1
      completed:
        type: boolean
  error:
    type: object
    required:
      - message
    properties:
      code:
        type: integer
        format: int64
      message:
        type: string
bash:~/temp$ swagger generate server -f swagger.yml 
2021/06/02 00:13:02 validating spec /home/user1/temp/swagger.yml
2021/06/02 00:13:02 preprocessing spec with option:  minimal flattening
2021/06/02 00:13:02 building a plan for generation
2021/06/02 00:13:02 generation target ./
2021/06/02 00:13:02 target must reside inside a location in the $GOPATH/src or be a module

santosh · 2021-06-02T09:13:24Z

Following these steps:

ec2-user at ip-172-31-45-160 in /efs $ cd /efs/repos/swaggerapi/
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ cat swagger.yml 
consumes:
- application/io.goswagger.examples.todo-list.v1+json
info:
  description: From the todo list tutorial on goswagger.io
  title: A Todo list application
  version: 1.0.0
paths: {}
produces:
- application/io.goswagger.examples.todo-list.v1+json
schemes:
- http
swagger: "2.0"
---
definitions:
  item:
    type: object
    required:
      - description
    properties:
      id:
        type: integer
        format: int64
        readOnly: true
      description:
        type: string
        minLength: 1
      completed:
        type: boolean
  error:
    type: object
    required:
      - message
    properties:
      code:
        type: integer
        format: int64
      message:
        type: string
---
paths:
  /:
    get:
      tags:
        - todos
      parameters:
        - name: since
          in: query
          type: integer
          format: int64
        - name: limit
          in: query
          type: integer
          format: int32
          default: 20
      responses:
        200:
          description: list the todo operations
          schema:
            type: array
            items:
              $ref: "#/definitions/item"
        default:
          description: generic error response
          schema:
            $ref: "#/definitions/error"
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ swagger generate server -A todo-list -f ./swagger.yml
couldn't find a swagger spec
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $

youyuanwu · 2021-06-05T16:45:48Z

Seems like the error is from here:

go-swagger/generator/spec.go

Line 144 in 43c2774

return "", errors.New("couldn't find a swagger spec")

Not sure how the spec file name is not picked up.

Can you try run swagger generate server without any argument in the dir with the spec file?

santosh · 2021-06-05T18:28:04Z

I get the same result.

casualjim · 2021-06-05T19:53:11Z

is this in or out of the go path, does the project have a go.mod file if it isn't?

casualjim · 2021-06-05T19:58:37Z

$ cd $(mktemp -d)   

/tmp/tmp.4HoE96p3Rl $ swagger generate server -f ./swagger.yaml 

2021/06/05 12:54:48 validating spec /tmp/tmp.4HoE96p3Rl/swagger.yaml
2021/06/05 12:54:49 preprocessing spec with option:  minimal flattening
2021/06/05 12:54:49 building a plan for generation
2021/06/05 12:54:49 generation target ./
2021/06/05 12:54:49 target must reside inside a location in the $GOPATH/src or be a module

/tmp/tmp.4HoE96p3Rl $ swagger generate server -f swagger.yaml

2021/06/05 12:54:55 validating spec /tmp/tmp.4HoE96p3Rl/swagger.yaml
2021/06/05 12:54:56 preprocessing spec with option:  minimal flattening
2021/06/05 12:54:56 building a plan for generation
2021/06/05 12:54:56 generation target ./
2021/06/05 12:54:56 target must reside inside a location in the $GOPATH/src or be a module

/tmp/tmp.4HoE96p3Rl $ go mod init goswagger.io/example/todo-list

go: creating new go.mod: module goswagger.io/example/todo-list

/tmp/tmp.4HoE96p3Rl $ swagger generate server -f swagger.yaml   

2021/06/05 12:55:16 validating spec /tmp/tmp.4HoE96p3Rl/swagger.yaml
2021/06/05 12:55:16 preprocessing spec with option:  minimal flattening
2021/06/05 12:55:16 building a plan for generation
2021/06/05 12:55:16 generation target ./
2021/06/05 12:55:16 planning definitions (found: 2)
2021/06/05 12:55:16 planning operations (found: 1)
2021/06/05 12:55:16 grouping operations into packages (packages: 1)
2021/06/05 12:55:16 operations for package packages "todos" (found: 1)
2021/06/05 12:55:16 planning meta data and facades
2021/06/05 12:55:16 rendering 2 models
2021/06/05 12:55:16 rendering 1 templates for model error
2021/06/05 12:55:16 name field error
2021/06/05 12:55:16 package field models
2021/06/05 12:55:16 creating generated file "error.go" in "models" as definition
2021/06/05 12:55:16 executed template asset:model
2021/06/05 12:55:16 rendering 1 templates for model item
2021/06/05 12:55:16 name field item
2021/06/05 12:55:16 package field models
2021/06/05 12:55:16 creating generated file "item.go" in "models" as definition
2021/06/05 12:55:16 executed template asset:model
2021/06/05 12:55:16 rendering 1 operation groups (tags)
2021/06/05 12:55:16 rendering 1 operations for todos
2021/06/05 12:55:16 rendering 4 templates for operation ATodoListApplication
2021/06/05 12:55:16 name field Get
2021/06/05 12:55:16 package field todos
2021/06/05 12:55:16 creating generated file "get_parameters.go" in "restapi/operations/todos" as parameters
2021/06/05 12:55:16 executed template asset:serverParameter
2021/06/05 12:55:16 name field Get
2021/06/05 12:55:16 package field todos
2021/06/05 12:55:16 creating generated file "get_urlbuilder.go" in "restapi/operations/todos" as urlbuilder
2021/06/05 12:55:16 executed template asset:serverUrlbuilder
2021/06/05 12:55:16 name field Get
2021/06/05 12:55:16 package field todos
2021/06/05 12:55:16 creating generated file "get_responses.go" in "restapi/operations/todos" as responses
2021/06/05 12:55:16 executed template asset:serverResponses
2021/06/05 12:55:16 name field Get
2021/06/05 12:55:16 package field todos
2021/06/05 12:55:16 creating generated file "get.go" in "restapi/operations/todos" as handler
2021/06/05 12:55:16 executed template asset:serverOperation
2021/06/05 12:55:16 rendering 0 templates for operation group ATodoListApplication
2021/06/05 12:55:16 rendering support
2021/06/05 12:55:16 rendering 6 templates for application ATodoListApplication
2021/06/05 12:55:16 name field ATodoListApplication
2021/06/05 12:55:16 package field operations
2021/06/05 12:55:16 creating generated file "main.go" in "cmd/a-todo-list-application-server" as main
2021/06/05 12:55:16 executed template asset:serverMain
2021/06/05 12:55:16 name field ATodoListApplication
2021/06/05 12:55:16 package field operations
2021/06/05 12:55:16 creating generated file "embedded_spec.go" in "restapi" as embedded_spec
2021/06/05 12:55:16 executed template asset:swaggerJsonEmbed
2021/06/05 12:55:16 name field ATodoListApplication
2021/06/05 12:55:16 package field operations
2021/06/05 12:55:16 creating generated file "server.go" in "restapi" as server
2021/06/05 12:55:16 executed template asset:serverServer
2021/06/05 12:55:16 name field ATodoListApplication
2021/06/05 12:55:16 package field operations
2021/06/05 12:55:16 creating generated file "a_todo_list_application_api.go" in "restapi/operations" as builder
2021/06/05 12:55:16 executed template asset:serverBuilder
2021/06/05 12:55:16 name field ATodoListApplication
2021/06/05 12:55:16 package field operations
2021/06/05 12:55:16 creating generated file "doc.go" in "restapi" as doc
2021/06/05 12:55:16 executed template asset:serverDoc
2021/06/05 12:55:16 name field ATodoListApplication
2021/06/05 12:55:16 package field operations
2021/06/05 12:55:16 creating generated file "configure_a_todo_list_application.go" in "restapi" as configure
2021/06/05 12:55:16 executed template asset:serverConfigureapi
2021/06/05 12:55:16 Generation completed!

For this generation to compile you need to have some packages in your GOPATH:

	* github.com/go-openapi/runtime
	* github.com/jessevdk/go-flags

You can get these now with: go get -u -f ./...

santosh · 2021-06-06T09:37:38Z

I did setup go modules, but didn't work out:

ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ go mod init gitlab.com/sntshk/swaggerapigo: creating new go.mod: module gitlab.com/sntshk/swaggerapi
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ ls
go.mod  swagger.yml
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ swagger generate server
couldn't find a swagger spec
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ swagger generate server -f ./swagger.yaml 
couldn't find a swagger spec
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ swagger generate server -f swagger.yaml 
couldn't find a swagger spec

youyuanwu · 2021-06-06T16:25:21Z

Is ther filename "swagger.yml" or "swagger.yaml"?

santosh · 2021-06-07T02:28:50Z

Sorry that I was using the wrong file name, but even after the correct extension, I don't see a difference:

ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ swagger generate server -f ./swagger.yml 
couldn't find a swagger spec
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ swagger generate server -f swagger.yml 
couldn't find a swagger spec
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $ swagger generate server 
couldn't find a swagger spec
ec2-user at ip-172-31-45-160 in /efs/repos/swaggerapi $

youyuanwu · 2021-06-11T21:27:18Z

I suggest you try generate under home directory, or try on another machine. It is unclear why swagger cannot read the file.

santosh · 2021-06-12T05:45:29Z

Unfortunately the same outcome is there in the home directory:

ec2-user at ip-172-31-45-160 in ~ $ ll | grep swag
-rw-rw-r-- 1 ec2-user ec2-user  1291 Jun 12 05:42 swagger.yml
ec2-user at ip-172-31-45-160 in ~ $ swagger generate server 
couldn't find a swagger spec
ec2-user at ip-172-31-45-160 in ~ $ swagger generate server -f swagger.yml 
couldn't find a swagger spec
ec2-user at ip-172-31-45-160 in ~ $ swagger generate server -f ./swagger.yml 
couldn't find a swagger spec

dinever · 2021-06-24T21:12:09Z

I have the same error

$ ls -l swagger.json
-rw-r--r--  1 dinever  staff    49K Jun 24 17:09 swagger.json
$ swagger generate markdown
couldn't find a swagger spec

dinever · 2021-06-24T21:18:48Z

Hi @santosh,

I feel like this might have something to do with running swagger from the Docker container, as volumes need to be mounted for the files to be read in the container. Are you running swagger from Docker?

You could try using the static binary https://goswagger.io/install.html#static-binary and see if it resolves the issue.

zhaozhaoyi · 2021-08-12T09:19:51Z

i think the init path is not right
alias swagger="docker run --rm -it --user $(id -u):$(id -g) -e GOPATH=$HOME/go:/go -v $HOME:$HOME -w $(pwd) quay.io/goswagger/swagger"
swagger version

swagger validate ./swagger/swagger.yml

open ./swagger/swagger.yml: no such file or directory

casualjim · 2021-08-12T16:32:34Z

i think the init path is not right
alias swagger="docker run --rm -it --user $(id -u):$(id -g) -e GOPATH=$HOME/go:/go -v $HOME:$HOME -w $(pwd) quay.io/goswagger/swagger"
swagger version

swagger validate ./swagger/swagger.yml

open ./swagger/swagger.yml: no such file or directory

try with:

alias swagger="docker run --rm -it --user $(id -u):$(id -g) -e GOPATH=$HOME/go:/go -v $HOME:$HOME -v $PWD:$PWD -w $PWD quay.io/goswagger/swagger"

shubinmi · 2021-10-07T16:06:25Z

looks like -f ./spec/swagger.yaml should be at the end of the command.
like //go:generate swagger generate server -A myApp -s restapi -t ./gen -f ./spec/swagger.yaml

santosh · 2021-11-29T11:12:53Z

I'm closing this issue as I'm able to run the same command without any issue in an environment different than Amazon Linux 2.

I was able to run this on below environment:

swagger version: v0.28.0
go version: go1.17.3
OS: Ubuntu 20.04 (WSL 2 | Docker 20.10.10)

youyuanwu added the needs more info label Jun 2, 2021

santosh closed this as completed Nov 29, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

couldn't find a swagger spec #2580

couldn't find a swagger spec #2580

santosh commented May 26, 2021

Planck1858 commented May 31, 2021

youyuanwu commented Jun 1, 2021

santosh commented Jun 2, 2021

youyuanwu commented Jun 2, 2021

santosh commented Jun 2, 2021

youyuanwu commented Jun 5, 2021

santosh commented Jun 5, 2021

casualjim commented Jun 5, 2021

casualjim commented Jun 5, 2021

santosh commented Jun 6, 2021

youyuanwu commented Jun 6, 2021

santosh commented Jun 7, 2021

youyuanwu commented Jun 11, 2021

santosh commented Jun 12, 2021

dinever commented Jun 24, 2021

dinever commented Jun 24, 2021

zhaozhaoyi commented Aug 12, 2021

casualjim commented Aug 12, 2021

shubinmi commented Oct 7, 2021

santosh commented Nov 29, 2021

couldn't find a swagger spec #2580

couldn't find a swagger spec #2580

Comments

santosh commented May 26, 2021

Problem statement

Steps to reproduce

Environment

Planck1858 commented May 31, 2021

youyuanwu commented Jun 1, 2021

santosh commented Jun 2, 2021

youyuanwu commented Jun 2, 2021

santosh commented Jun 2, 2021

youyuanwu commented Jun 5, 2021

santosh commented Jun 5, 2021

casualjim commented Jun 5, 2021

casualjim commented Jun 5, 2021

santosh commented Jun 6, 2021

youyuanwu commented Jun 6, 2021

santosh commented Jun 7, 2021

youyuanwu commented Jun 11, 2021

santosh commented Jun 12, 2021

dinever commented Jun 24, 2021

dinever commented Jun 24, 2021

zhaozhaoyi commented Aug 12, 2021

casualjim commented Aug 12, 2021

shubinmi commented Oct 7, 2021

santosh commented Nov 29, 2021