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

Finish Swagger Implementation #11

Open
hotwer opened this issue Feb 8, 2023 · 0 comments
Open

Finish Swagger Implementation #11

hotwer opened this issue Feb 8, 2023 · 0 comments

Comments

@hotwer
Copy link

hotwer commented Feb 8, 2023

Swagger was implemented using the swag for Go library and buffalo-swagger, but right there are some issues regarding it that are preventing us to finish this implementation.

Issues

  • Right now it's required that the docs.go file that is generated dynamically using the swag command is required to be import in the app.go file. This is an issue because it requires that dinamically generated files are required to be versioned, which isn't a good practice. Important to note that this is officialy required by buffalo-swagger documentation, as the import suggestion required it to import directly from github, so it expects the file to be versioned in git.
  • All the comments are generated manually right now. Since I didn't dig much into the swag docs, I'm not sure if there's faster/easy way to generate documentations, but since Go is a type defined language, that makes me believe it probably exists.
  • Swagger has security details regarding how the authentication works so jt can automatically authenticate before calling the APIs routes to the browser. I didn't dive much into how those settings works, so right now it's not possible to call the APIs directly without manually login-in and passaing the authorization bearer token.
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

1 participant