C# WebAPI中使用Swagger
前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要, swagger 就是一款让你更好的书写API文档的框架。 没有API文档工具之前,大家都是手写API文档的,在什么地方书写的都有,有在 confluence 上写的,有在对应的项目目录下 readme.md 上写的,每个公司都有每个公司的玩法,无所谓好坏。 书写API文档的工具有很多,但是能称之为“框架”的,估计也只有 swagger 在此先介绍一款其他的API文档工具,叫 rap RAP RAP 是由阿里开发的,整个阿里都在用,还不错。github地址为: https://github.com/thx/RAP 当然咯, rap https://github.com/thx/RAP/wiki/deploy_manual_cn swagger rap 先看看swagger的生态使用图: 其中,红颜色的是 swaggger 官网方推荐的。 下面再细看看swagger的生态的具体内容: swagger-ui 这玩意儿从名字就能看出来,用来显示API文档的。和 rap 不同的是,它不可以编辑。 swagger-editor 左边编辑,右边立马就显示出编辑内容来。 编辑swagger说明文件使用的是 yaml 语法具体的内容可以去官网查看。 目前最流行的做法