Swagger能成为最受欢迎的REST APIs文档生成工具之一,有以下几个原因: Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API. Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现. Swagger 文件可以在许多不同的平台上从代码注释中自动生成. Swagger 有一个强大的社区,里面有许多强悍的贡献者. 反正就是很6,很棒棒,我平常接口开发都会用到Swagger,感觉挺方便,不用怎么写文档就可以快速的和前端完成对接(我在实际开发和…

本文主要参考:Using Swagger with ASP.net Core 1.创建WebApi项目 本文使用ASP.Net Core Web API项目模板演示Swagger到使用,首先创建Web Api项目. 通过Nuget安装Swashbuckle.AspnetCore 也可以通过指令 Install-Package Swashbuckle.AspNetCore 2.Swagger配置 配置ConfigureServices public void ConfigureServices(I…

1.先通过NuGet安装Swashbuckle.AspNetCore ,支持.NET core,版本是4.0.1,以上版本好像有些功能不支持 2.startup文件里注入swagger,ConfigureServices 方法注入swagger内容, #region 添加SwaggerUI services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new Info { Title = "钉钉测试文档&quo…

abp已经自带了swagger,但是我们的文档注释swagger并没有做处理,需要我们自己手动处理一下 1.对Application层配置xml输出,一般勾上xml,默认的地址就可以啦! 2.修改Startup.cs文件,再services.AddSwaggerGen里面加入如下两行代码 options.IncludeXmlComments(Path.Combine(PlatformServices.Default.Application.ApplicationBasePath, "JiaoZi…

废话不多说直接来看 第一步: 安装nuget包:Swashbuckle.AspNetCore.Swagger Swashbuckle.AspNetCore.SwaggerGen Swashbuckle.AspNetCore.SwaggerUI 安装好后就可以看到啦 第二步:找到Startup开始在ConfigureServices 配置 1 public void ConfigureServices(IServiceCollection services) 2 { 3 services.AddC…

首先要现有一个asp.net  webApi项目 这里就不赘述了,接下来就按下面的步骤进行即可(本文是基于swagger 1.0.0-rc3版本的配置) 1.在project.json中添加 swagger的包名   "Swashbuckle.AspNetCore": "1.0.0-rc3", 保存后vs会自动下载swagger的包 这个可能会需要一定的时间 2.在status.cs中添加swagger的相关配置 public void ConfigureServi…

今天突然点开写好的接口,突然发现展开时同时展开了两个接口.如图 我点这两个接口任意一个,这两个都会同时展开或折叠. 原因是他们actinName相同,虽然在vs里面只要http方法不同,action是可以相同的. 但是swagger里面却不允许,所以只要action不同就行了. 路由是不影响的.…

系列目录: [Docker] CentOS7 安装 Docker 及其使用方法 ( 一 ) [Docker] 使用Docker 在阿里云 Centos7 部署 MySQL 和 Redis (二) [Docker] .Net Core 3.1 webapi 集成EF Code First,使用MySql进行业务操作 .配置swagger (三) .......持续不定期更新中 之前一直用.Net Core 2.1 ,发现3.1后有很多地方和原来的操作不同,踩了一些坑,所以记录一下3.1的操作方法…

最近在做微服务的时候,由于我们是采用前后端分离来开发的,提供给前端的直接是Swagger,如果Swagger分布在各个API中,前端查看Swagger的时候非常不便,因此,我们试着将Swagger集中放到网关中. 这里我用两个API项目(一个BasicDataApi,一个UsersApi)和一个网关项目(ApiGateway)做示例,下面直接上代码. 首先在BasicDataApi中配置Swagger: public void ConfigureServices(IServiceCollecti…

最近在做微服务的时候,由于我们是采用前后端分离来开发的,提供给前端的直接是Swagger,如果Swagger分布在各个API中,前端查看Swagger的时候非常不便,因此,我们试着将Swagger集中放到网关中. 这里我用两个API项目(一个BasicDataApi,一个UsersApi)和一个网关项目(ApiGateway)做示例,下面直接上代码. 首先在BasicDataApi中配置Swagger: public void ConfigureServices(IServiceCollecti…

这个很简单的一篇文章用来记录以下使用swagger的过程,以后有用. 1.nuget 下载install-package Swashbuckle.AspNetCore 2.startup里面configureservice配置: services.AddSwaggerGen(c => { //添加document,这个主要用来在swaggerUI页面上面显示一些额外的信息 //注意第一个参数"pangjianxin"这个参数要和startup中configure方法中的 //c.…

测试/生产环境的BUG 这里更新一下在本地调试正常,在INT/PROD上抛错,错误信息为: */**/*.xml(Swagger json file) 文件找不到,在startup 里builder 的时候抛出错误. 解决方案: 编辑.csproj文件,修改输出路径, <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'"> <DocumentationFile>bin\…

阅读目录 1.引用 2.打开startup.cs文件 3.设置XML注释 4.运行结果 5.主要问题的解决办法 6.可以自定义UI 前言 最近写了好多Web api, 老大说太乱了,要整理一下,使用Swagger.花了半天的时间,在这里记录和分享一些过程和遇到的问题. 遇到的主要问题:1.localhost:9040/swagger/ not found 2.http://localhost:9040/swagger界面可以打开,但是can't read json file. 回到顶部 1.引用…

参考地址:http://www.cnblogs.com/daxnet/p/6181366.html http://www.jianshu.com/p/fa5a9b76f3ed 微软参考文档:https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-studio 在 .net core 中使用 swagger 生成接口文档跟在 asp.net 中使用方式一样…

Swagger简介: Swagger™的目标是为REST APIs 定义一个标准的,与语言无关的接口,使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能.当服务通过Swagger定义,消费者就能与远程的服务互动通过少量的实现逻辑.类似于低级编程接口,Swagger去掉了调用服务时的很多猜测. 创建一个Asp.Net Core WebApi项目. 想要使用我们的Swagger你必须有Api,所以呢我们先构造一个数据库,当然我们可以使用DbFist,我们…

C#中缓存的使用   缓存的概念及优缺点在这里就不多做介绍,主要介绍一下使用的方法. 1.在ASP.NET中页面缓存的使用方法简单,只需要在aspx页的顶部加上一句声明即可:  <%@ OutputCache Duration="100" VaryByParam="none" %> Duration:缓存时间(秒为单位),必填属性 2.使用微软自带的类库System.Web.Caching 新手接触的话不建议直接使用微软提供的类库,因为这样对理解不够深刻…

原文:NET Framework项目移植到NET Core上遇到的一系列坑 版权声明:本文为博主原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明. 本文链接:https://blog.csdn.net/zt102545/article/details/87968865 目录 1.获取请求的参数 2.获取完整的请求路径 3.获取域名 4.编码 5.文件上传的保存方法 6.获取物理路径 7.返回Json属性大小写问题 8.webconfig的配置移植到appsettin…

[1]安装Swashbuckle.AspNetCore包 [2]在Startup.cs中注册swagger //注册Swagger生成器,定义一个和多个Swagger 文档 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "爱住微订API", Version = "v1" }); }); [3]在Startup.cs中配置swagger app.UseS…

微软参考文档:https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-studio 在 .net core 中使用 swagger 生成接口文档跟在 asp.net 中使用方式一样,但把 swagger 添加到项目中不在生成SwaggerConfig.cs 文件 ,需自己配置. 项目引入Swagger 我这里安装的是VS2017, 当然 VS Code也…

上一篇介绍了Swashbuckle ,地址:.net core的Swagger接口文档使用教程(一):Swashbuckle 讲的东西还挺多,怎奈微软还推荐了一个NSwag,那就继续写吧! 但是和Swashbuckle一样,如果还是按照那样写,东西有点多了,所以这里就偷个懒吧,和Swashbuckle对照的去写,介绍一些常用的东西算了,所以建议看完上一篇再继续这里. 一.一般用法 注:这里一般用法的Demo源码已上传到百度云:https://pan.baidu.com/s/1Z4Z9H9nto_…

Swagger 是个好东西,对于前后端分离的网站来说,不仅是提高前后端开发人员沟通效率的利器,也大大方便了后端人员测试 API.有时候,API 中可能需要在 Header 中设置认证参数,比如 authToken,这样的功能我们通常是使用 ActionFilter 实现的,这就会导致 swagger UI 中缺少 authToken 字段,下面就来介绍解决这个问题的办法. 创建一个过滤器类,内容如下: /// <summary> /// this class is for swagger to…

ASP.NET Core中如何配置Kestrel Urls呢,大家可能都知道使用UseUrls() 方法来配置. 今天给介绍全面的ASP.NET Core 配置 Urls,使用多种方式配置Urls.让你了解ASP.NET Core Kestrel 的地址设置.下面我们就来了解如何配置.我将介绍4种方式来配置Urls. 1.UseUrls方法 大家最熟悉的一种也就是使用UseUrls .下面我们就来实际使用.UseUrls 方法可以使用多个地址,也可以使用一个地址.单个网址  UseUrls("h…

.NET Core为我们提供了一套用于配置的API,它为程序提供了运行时从文件.命令行参数.环境变量等读取配置的方法.配置都是键值对的形式,并且支持嵌套,.NET Core还内建了从配置反序列化为POCO对象的支持. 目前支持以下配置Provider: 文件(INI,JSON,XML) 命令行参数 环境变量 内存中的.NET对象 User Secrets Azure Key Vault 如果现有Provider不能满足你的使用场景,还允许自定义Provider,比如从数据库中读取. 配置相关的包…

<10分钟就能学会.NET Core配置>里详细介绍了.NET Core配置的用法,另外我还开源了自定义的配置Provider:EF配置Provider和Yaml配置Provider.本文先来聊聊EF配置Provider的实现,其中会涉及到EntityFramework Core的知识,不熟悉也没关系,且听我慢慢讲来. 配置执行流程 在使用配置的时候都是先new ConfigurationBuilder(),最后调用Build()方法赋值给Configuration属性.那我们就从这个Buil…

YAML是一种更适合人阅读的文件格式,很多大型的项目像Ruby on Rails都选择YAML作为配置文件的格式.如果项目的配置很少,用JSON或YAML没有多大差别.看看rails项目中的配置文件,如果用JSON写试试什么感受吧. 在<实现自己的.NET Core配置Provider之EF>中已经讲过配置的执行流程,这里不再复述,直接动手. YamlConfigurationProvider Yaml是基于文件的,可以直接从FileConfigurationProvider继承,在FileC…

近期一直在学习Asp.net Core,微软的文档太难看,都是英文翻译过来的,很不友好,感谢这个博客,从壹开始前后端分离[ .NET Core2.0 +Vue2.0 ],让我入门了,刚学到这个Swagger时,我就有个需求,因为我之前写过的系统是分了不同的模块,模块里面再分控制器,不同模块经常会有相同名称的控制器,例如销售中心模块里有个合同管理控制器,采购中心模块里也有个合同管理控制器,而且我一个系统接口可能得上百个,那如果都在一个页面显示的话,那也太多了,所以我想能不能把接口进行分组. 在博客…

nginx与fastdfs配置详解与坑 环境 ubantu19.04 fastdfs-5.11 fastdfs-nginx-module-1.20 libfastcommon-1.0.39 nginx-1.15.12 pcre2-10.33 openssl-1.0.2r nginx配置过程 https://blog.csdn.net/tjcyjd/article/details/69663348 ssl与依赖库 https://blog.csdn.net/g1531997389/article/…

.NET Core为我们提供了一套用于配置的API,它为程序提供了运行时从文件.命令行参数.环境变量等读取配置的方法.配置都是键值对的形式,并且支持嵌套,.NET Core还内建了从配置反序列化为POCO对象的支持. 目前支持以下配置Provider: 文件(INI,JSON,XML) 命令行参数 环境变量 内存中的.NET对象 User Secrets Azure Key Vault 如果现有Provider不能满足你的使用场景,还允许自定义Provider,比如从数据库中读取. 配置相关的包…

asp.net core配置访问地址  .net core web程序,默认使用kestrel作为web服务器. 配置Kestrel Urls有四种方式,我这里只介绍一种.其它方式可自行百度. 在Program.cs里使用UseUrls()扩展方法进行设置.UseUrls()方法的参数是个字符串数组,可以同时设置多个访问地址,比如: UseUrls("http://10.101.56.52,http:// 10.101.56.52:80,http:// 10.101.56.52:8080&quo…

修改npm安装的全局路径和配置环境变量的坑 转自:http://www.qdfuns.com/notes/30749/0f66fcf5e62eed010f744d0d4adaa870.html 我之前安装npm时全是默认安装,模块全部安装在C盘了,今天心血来潮,把路径改到了D盘,结果改完后模块都不能识别了,都提示XX模块不是内部命令,这其实是环境变量配置的问题,我都是按照网上的教程改的环境变量,但是照着改也有错,反复改了好几次都不行,最后终于改好了.步骤如下: 1.要在你需要存放模块的文件夹里建…