corehttp

前言 回顾上一篇文章 《使用Swagger做Api文档 》 ，文中介绍了在.net core 3.1中，利用Swagger轻量级框架，如何引入程序包，配置服务，注册中间件，一步一步的实现，最终实现生产自动生产API接口说明文档。文中结尾也留下了一个让大家思考的问题。在这里，我们重新回顾一下这几个问题 1. 已经有接口了，但如何添加注释呢？ 2. 作为接口使用者，我们关心的是接口的返回内容和响应类型，那我们如何定义描述响应类型呢？ 3. 在项目开发中，使用的实体类，又如何在Swagger中展示呢？ 4. 在部署项目，引用Swagger既有文档又不需要额外部署，但是如何在开发环境中使用，而在生产环境中禁用呢？ 开始 一、为接口方法添加注释 1 . 按照下图所示 连点三次 / 即可添加文档注释 如下所示 2.启用XML 注释 右键web 项目名称=>属性=>生成 ，勾选“输出”下面的“ xml文档文件 ”，系统会默认生成一个,如下图所示 3.配置服务 在之前注册的Swagger服务代码中，添加以下几行代码，引入xml文件 var basePath = Path.GetDirectoryName( typeof (Program).Assembly.Location); // 获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径） // var basePath =

前言 为什么在开发中，接口文档越来越成为前后端开发人员沟通的枢纽呢？ 随着业务的发张，项目越来越多，而对于支撑整个项目架构体系而言，我们对系统业务的水平拆分，垂直分层，让业务系统更加清晰，从而产生一系统平台和系统，并使用接口进行数据交互。因此可见，业务的不断发展，接口不断增多，很多接口各自寄宿在不同的项目中，如果没有使用api工具进行管理，那么使用和说明将变得非常复杂。所以，接口管理运营应运而生。 在过去的开发中，没有API文档管理工具之前，很多的API文档在什么地方写的都有，有在word写的，有在excel写的，也有对应的项目目录下readme.md写的，每个公司都有每个公司的玩法，但是文档规范极其不统一，甚至出现开发接口更新，但文档不更新，最终导致代码和接口不匹配，开发功能出问题。撸码一分钟，对接三小时。这往往是大家最痛苦的。 因此，在前后端分离的情况下，怎样让前后端开发人员更容易、更直观、更舒服的方式进行沟通交流。在这里，推荐一款轻量级的项目框架Swagger给大家使用。Swagger就是一款让你更好书写API文档的框架 开始 一、 引用Swagger的nuget包 Swashbuckle.AspNetCore 然后就在项目的Nuget依赖里看到刚刚引入的Swagger 二、服务配置环节 在 Startup.cs 页面中： 编辑 ConfigureServices 类：