Struct fields supported for header and path param types

[tanenbaum]

Describe the PR
Supports "object" (i.e. struct model) data types for header and path parameter types via @Param operation comment in the same way that query and formData already work - basic structs are supported to represent multiple paramters at once.

This allows struct models, e.g. for a number of related headers, to be used directly rather than duplicating all the @Param comments for every field in those structs.

This works similarly to existing formData and query types and largely reuses all the same operation parsing logic.

In addition this supports using struct tags header:"name" and uri:"name" for header and path params respectively. This follows the Gin specific tag naming conventions.

Relation issues
A few issues with similar feature requests:

• Implement tags for request params structs #248
• Support httpin tags for automatically generating params from structs. #1720
• Parse error: Struct is not supported for type of header #1197 (closed in error I believe)

[tanenbaum]

Looking at rebasing this and fixing the conflicts - I'm not sure if the change introduced in #1706 return strings.TrimRight(strings.TrimSpace(strings.Split(ps.tag.Get(formTag), ",")[0]), "[]") is in fact backwards compatible - what about API definitions where people want to include the [] characters at the end of their parameter names? While not common, it could cause unwanted doc changes.

@sdghchj what do you think about this? Should all the fields trim "[]"? I'm not so sure.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (76695ca) 83.25% compared to head (c7eb9f5) 83.32%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1740      +/-   ##
==========================================
+ Coverage   83.25%   83.32%   +0.06%     
==========================================
  Files          16       16              
  Lines        3811     3815       +4     
==========================================
+ Hits         3173     3179       +6     
+ Misses        542      541       -1     
+ Partials       96       95       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sdghchj]

[] is trivial, make nonsense.  trim them.

…

------------------ Original ------------------ From: Joe Shaw ***@***.***> Date: Thu,Jan 18,2024 7:48 PM To: swaggo/swag ***@***.***> Cc: sdghchj ***@***.***>, Mention ***@***.***> Subject: Re: [swaggo/swag] Struct fields supported for header and path paramtypes (PR #1740) Looking at rebasing this and fixing the conflicts - I'm not sure if the change introduced in #1706 return strings.TrimRight(strings.TrimSpace(strings.Split(ps.tag.Get(formTag), ",")[0]), "[]") is in fact backwards compatible - what about API definitions where people want to include the [] characters at the end of their parameter names? While not common, it could cause unwanted doc changes. @sdghchj what do you think about this? Should all the fields trim "[]"? I'm not so sure. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.Message ID: ***@***.***>

[tanenbaum]

[] is trivial, make nonsense.  trim them.

Fair enough - rebased and updated.