2020-07-21 标签:swagger,自定义,api,文档,方法,注释,对象,IEnumerable,Entities,Reces,返回,定义,代码,生成,asp.net,web,SwaggerResponse,HttpStatusCode,OK,data

asp.net web api 的swagger方法的自动生成的api文件都是默认是返回对象的实体注释,有没有办法自己定义这个对象呢,这个肯定是有的啦,swagger开发者早想到这种情况了.swagger自定义api文档方法的注释对象代码如下:其中 [SwaggerResponse(Ht

2020-07-20 标签:asp.net,api,webform,swagger,忽略,控制器,生成,文档,IgnoreApi,true,Json,controller,BaseController,ApiExplorerSettings,public,HttpResponseMessage,obj,string

今天在用asp.net api webform swagger自动生成api文档时,发现默认是全部控制器(controller)都会生成api文档的,但实际上我们有些控制器不想生成文档,比如BaseController之类的,那该如何控制呢?swagger忽略某控制器不生成文档的代码如下

2020-03-14 标签:asp,net,core,webapi,使用,swagger,api,隐藏,分组,详解,前言,部分,接口,代替,难免,直观,暴露出,比如,结合

1、前言为什么我们要隐藏部分接口？因为我们在用swagger代替接口的时候，难免有些接口会直观的暴露出来，比如我们结合Consul一起使用的时候，会将健康检查接口以及报警通知接口暴露出来，这些接口有时候会出于方便考虑，没有进行加密，这个时候我们就需要把接口隐藏起来，只有内部的开发者知道。为什么要分组

2020-03-14 标签:asp,net,core,swagger,使用,接口,处理,方法,引用,作者,原话,webapi,中使,作为,说明,测试

引用作者原话：Asp.Net的WebApi中使用Swagger作为说明和测试的页面是非常不错的，比起WebApiTestClient来至少在界面上的很大的提升。但是使用Swagger时如果只是一般的控制器直接放到Controller下就可以了，而如果因不同的业务需求而需要分类或者有同名的类名时时则没

2020-03-14 标签:asp,net,core,使用,swagger,生成,api,文档,完整,步骤,前言,集成,nswag,分别为,swashbuckle,两者,配置,大同小异,为例

前言.Net Core中有两个集成NSwag的包，分别为Swashbuckle和NSwag。两者的配置大同小异。这里以NSwag为例。一、前期准备1、初始化asp.net core 测试项目新建asp.net core项目，此处略过；新建apicontroller，并编写测试代码；[Route("a

2020-03-14 标签:asp,n,et,core,中使,swagger,方法,问题,intro,上次,更新,简单,记录,使用,项目,api,比较简单,匿名

Intro#上次更新了 asp.net core 3.0 简单的记录了一下 swagger 的使用，那个项目的 api 比较简单，都是匿名接口不涉及到认证以及 api 版本控制，最近把另外一个 api 项目升级到了 3.0，还是遇到了一些问题，这里单独写一篇文章介绍，避免踩坑。Swagger 基本使