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

Could you extend the README a little? #1

Open
philsturgeon opened this issue Jul 23, 2018 · 4 comments
Open

Could you extend the README a little? #1

philsturgeon opened this issue Jul 23, 2018 · 4 comments

Comments

@philsturgeon
Copy link

Hey there! This looks great, and it's really exciting to see an OpenAPI v3 parser for Go, but could you consider adding a little more to the README so folks can see how it works?

@nkev
Copy link

nkev commented Jul 23, 2018

@philsturgeon Have a look at this one too: https://github.com/getkin/kin-openapi It's been around for a while (recently been moved to it's own repo).

@philsturgeon
Copy link
Author

philsturgeon commented Jul 24, 2018 via email

@nkev
Copy link

nkev commented Jul 24, 2018

This one is more lightweight and has a clear focus, while the kin-openapi has more functionality. If you need protobuf-openapi interoperability, also have a look at Google's https://github.com/googleapis/gnostic

@morlay
Copy link
Member

morlay commented Jul 24, 2018

hi @philsturgeon
go doc have some example https://godoc.org/github.com/go-courier/oas#OpenAPI

I used this pkg for my framework courier to pick openapi spec from code.
https://github.com/go-courier/httptransport/tree/master/openapi/generator
https://github.com/go-courier/httptransport/tree/master/__examples__

I will add doc for each exposes after whole framework stable enough.

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

No branches or pull requests

3 participants