Open
Description
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 theswag
command is required to be import in theapp.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.
Activity