基于.NetCore3.1搭建项目系列 —— 使用Swagger做Api文档 (上篇)

网友投稿 303 2022-06-07


前言

  为什么在开发中,接口文档越来越成为前后端开发人员沟通的枢纽呢?

  随着业务的发张,项目越来越多,而对于支撑整个项目架构体系而言,我们对系统业务的水平拆分,垂直分层,让业务系统更加清晰,从而产生一系统平台和系统,并使用接口进行数据交互。因此可见,业务的不断发展,接口不断增多,很多接口各自寄宿在不同的项目中,如果没有使用api工具进行管理,那么使用和说明将变得非常复杂。所以,接口管理运营应运而生。

  在过去的开发中,没有API文档管理工具之前,很多的API文档在什么地方写的都有,有在word写的,有在excel写的,也有对应的项目目录下readme.md写的,每个公司都有每个公司的玩法,但是文档规范极其不统一,甚至出现开发接口更新,但文档不更新,最终导致代码和接口不匹配,开发功能出问题。撸码一分钟,对接三小时。这往往是大家最痛苦的。    

                     

  因此,在前后端分离的情况下,怎样让前后端开发人员更容易、更直观、更舒服的方式进行沟通交流。在这里,推荐一款轻量级的项目框架Swagger给大家使用。Swagger就是一款让你更好书写API文档的框架

开始

一、 引用Swagger的nuget包

  Swashbuckle.AspNetCore

 然后就在项目的Nuget依赖里看到刚刚引入的Swagger

二、服务配置环节


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:为我开发的API添加华丽的外衣
下一篇:.NET Core学习笔记(5)——WebAPI从Server端push消息到Client
相关文章

 发表评论

暂时没有评论,来抢沙发吧~