开发 web api 的时候写文档是个痛苦的倳情,而没有文档别人就不知道怎么调用所以又不得不写。
swagger UI 可以自动生成接口文档并测试接口,极大的解放了程序员的生产力
咹装完成后,App_Start 文件夹下会多出一个 Web API 中是可以存在 路由相同,HTTP 方法相同查询参数不同 的方法的,但不好意思swagger UI 中不支持,并且会直接报錯
此配置的意思是,当遇到此种情况时取第一个方法展示。
这可以避免报错但多个方法只会在 swagger UI 中展示一个。治标不治本不推荐。所以唯一的解决方案就是设置成不同的路由不知道这个问题在之后的版本中会不会修复。
如下图新建用户时,后台需要一个 User 类作为参数点击右侧的 Model
,可以显示 User 类的属性及注释
但是,有些字段其实是无需调用者传递的例如 State
,调用者无需知道这些字段的存在
当然这种做法也是有缺点的,因为 web api 在返回数据时调用的默认序列化方法也是 Newtonsoft.Json 序列化。
我们在方法中返回一个 400
开发 web api 的时候写文档是个痛苦的倳情,而没有文档别人就不知道怎么调用所以又不得不写。
swagger UI 可以自动生成接口文档并测试接口,极大的解放了程序员的生产力
咹装完成后,App_Start 文件夹下会多出一个 Web API 中是可以存在 路由相同,HTTP 方法相同查询参数不同 的方法的,但不好意思swagger UI 中不支持,并且会直接报錯
此配置的意思是,当遇到此种情况时取第一个方法展示。
这可以避免报错但多个方法只会在 swagger UI 中展示一个。治标不治本不推荐。所以唯一的解决方案就是设置成不同的路由不知道这个问题在之后的版本中会不会修复。
如下图新建用户时,后台需要一个 User 类作为参数点击右侧的 Model
,可以显示 User 类的属性及注释
但是,有些字段其实是无需调用者传递的例如 State
,调用者无需知道这些字段的存在
当然这种做法也是有缺点的,因为 web api 在返回数据时调用的默认序列化方法也是 Newtonsoft.Json 序列化。
我们在方法中返回一个 400