Allow overriding swagger type in struct fields #234
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for a new struct field tag,
swaggertype
. It allows user to redefine the resulting swagger type of a struct field. It comes in 2 formats:swaggertype:<prim_type>
sets the swagger type of the field to the given<prim_type>
swaggertype:array,<prim_type>
sets the swagger type of the field to "array" and the swagger type of its items to<prim_type>
This feature is useful when you have custom types that are not supported by
swag
tool yet, but nevertheless have a corresponding swagger type that fits them well, i.e.sql.NullInt64
can be simplyinteger
,big.Float
can benumber
, etc. While it would be nice to support these types out of the box, it is not possible to do so for every custom wrapper; that's why I think this feature could be valuable, but please feel free to disagree :)