Thursday, 15 January 2015

asp.net web api2 - Using ActionName attribute seems to break Swagger documentation (Web API, Swashbuckle) -



asp.net web api2 - Using ActionName attribute seems to break Swagger documentation (Web API, Swashbuckle) -

i'm trying generate api documentation web api project using xml comments via swagger & swashbuckle. seems using actionname attribute on action breaks somewhere along line. action included in generated xml , shows in swagger ui, there no details (summary, param, etc) when click on it. i'm not sure if .net, swagger, or swashbuckle issue.

i've tried , without actionname attribute , seems have no impact on xml gets generated. attribute does, however, alter name displayed in swagger. leads me believe might have swagger/swashbuckle... maybe apiexplorer?

i've determined bug in swashbuckle. .net generates xml documentation actual method name, not name specified in actionname attribute. therefore, needs handled in swashbuckle code. i've entered issue in github, including workaround until fixed -- https://github.com/domaindrivendev/swashbuckle/issues/118.

asp.net-web-api2 swagger

No comments:

Post a Comment