资讯

精准传达 • 有效沟通

从品牌网站建设到网络营销策划,从策略到执行的一站式服务

Swagger在ASP.NetCore项目中使用的方法-创新互联

Swagger在ASP.NetCore项目中使用的方法?相信很多没有经验的人对此束手无策,为此本文总结了问题出现的原因和解决方法,通过这篇文章希望你能解决这个问题。

创新互联-专业网站定制、快速模板网站建设、高性价比滨海新区网站开发、企业建站全套包干低至880元,成熟完善的模板库,直接使用。一站式滨海新区网站制作公司更省心,省钱,快速模板网站建设找我们,业务覆盖滨海新区地区。费用合理售后完善,十载实体公司更值得信赖。

什么是swagger


使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。


Swagger在ASP.NetCore项目中使用的方法


Swagger™ 的目标是为 REST APIs 定义一个标准的,与语言无关的接口。只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具,就可以做到生成各种格式的接口文档,生成多种语言的客户端和服务端的代码,以及在线接口调试页面等。

所带来的帮助

当项目处于启动阶段
如果有了稳定的后台框架,直接依据业务需求编写服务端被调用层的代码(即controller及其入参出参对象),然后通过Swagger生成相关描述文件,使用者就可以直接使用了。
如果后台框架不成熟或在设计中,但是依据业务需求我们可以完成更多的工作而不是等待,先根据数据需求编写Swagger描述文件,通过该描述文件生成接口文档,指引项目的相关开发。
当项目处于迭代阶段
在项目的持续开发中,后端人员无需关注Swagger描述文件和接口文档,有需求变更导致接口变化,可直接编程实现,然后生成新的描述文件和接口文档后,给到前端即可。

使用Swagger

首先,先创建一个新的WebAPI项目,并在Nuget中找到对应的包,搜索Swashbuckle会出现很多应用包,可以根据描述选择自己需要的引用。我在这里使用的是Swashbuckle.AspNetCore.Filters

Swagger在ASP.NetCore项目中使用的方法

接下来在Startup中插入如下代码
注册服务

services.AddSwaggerGen(options =>
      {
        options.SwaggerDoc("v1", new OpenApiInfo
        {
          Title = "HTTP API 目录",
          Version = "v1",
          Description = "目录微服务HTTP API。"
        });
      });

网页标题:Swagger在ASP.NetCore项目中使用的方法-创新互联
文章源于:http://cdkjz.cn/article/pispe.html
多年建站经验

多一份参考,总有益处

联系快上网,免费获得专属《策划方案》及报价

咨询相关问题或预约面谈,可以通过以下方式与我们联系

业务热线:400-028-6601 / 大客户专线   成都:13518219792   座机:028-86922220