Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide complete documentation for generating client #2187

Open
davix opened this issue Jan 21, 2020 · 1 comment
Open

Provide complete documentation for generating client #2187

davix opened this issue Jan 21, 2020 · 1 comment

Comments

@davix
Copy link

@davix davix commented Jan 21, 2020

Problem statement

Not a bug, but a query and requirement.

As a new go-swagger user, I'm following doc to generate client (https://goswagger.io/generate/client.html). But the doc is too simple and lacks necessary explanation.

For example, what's the imported "github.com/myproject/client/operations" in the sample code. The generated todo-list client code doesn't contain any "operations" directory.

├── client
│   ├── a_todo_list_application_client.go
│   └── todos
│   ├── add_one_parameters.go
│   ├── add_one_responses.go
│   ├── destroy_one_parameters.go
│   ├── destroy_one_responses.go
│   ├── find_todos_parameters.go
│   ├── find_todos_responses.go
│   ├── todos_client.go
│   ├── update_one_parameters.go
│   └── update_one_responses.go
└── models
├── error.go
└── item.go

Can we enhance the doc by providing the steps on how the generated client can interacting with the generated server?

Thanks!

@fredbi fredbi added the doc label Jan 21, 2020
@Mistobaan
Copy link

@Mistobaan Mistobaan commented May 26, 2020

Please, I am 1h in and still haven't found a full non-templated example of how to generate the client.! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.