一丶前言 最近刚接触到Swagger,在github上下载了它的源码和demo学习了一遍,发现这个组件非常好用,不过不足的是它没有导出离线文档的功能,于是乎我就想给它加一个导出功能 Swagger Github开源地址 二丶思路 其实说白了api文档就是一个html静态页面,html可以转word或者pdf,那问题就变简单了. 1.想办法拿到swagger生成的api接口json数据. 2.将json转化为html. 3.将html转换成word或者pdf等文件. 三丶实现 1.首先我们要解决第

集成.NET Core+Swagger+Consul+Polly+Ocelot+IdentityServer4+Exceptionless+Apollo的微服务开发框架 Github源代码地址 https://github.com/PeyShine/Demo.MicroServer Apollo配置中心 Apollo(阿波罗)是携程框架部门研发的分布式配置中心,能够集中化管理应用不同环境.不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限.流程治理等特性,适用于微服务配置管理场景

写在前面 是这样的,我们现在接口使用了Ocelot做网关,Ocelot里面集成了基于IdentityServer4开发的授权中心用于对Api资源的保护.问题来了,我们的Api用了SwaggerUI做接口的自文档,那就蛋疼了,你接入了IdentityServer4的Api,用SwaggerUI调试.调用接口的话,妥妥的401,未授权啊.那有小伙伴就会说了,你SwaggerUI的Api不经过网关不就ok了?诶,好办法.但是: 我不想改变Url规则啊,我是/api开头的Url都是经过网关的,如果不经过

Package 添加并配置Swagger中间件 将Swagger生成器添加到方法中的服务集合中Startup.ConfigureServices: public void ConfigureServices(IServiceCollection services) { services.AddMvc(); services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "WoorldCup Api&

一.入门 https://www.nuget.org/packages/Swashbuckle.AspNetCore.SwaggerGen/ 1.添加核心NUGET包 Swashbuckle.AspNetCore: 2.startup中配置: ConfigureServices中: //注册swagger生成器,定义一个或多个swagger文档 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Version

1. dotnet core 2.1 的下载地址 https://dotnet.microsoft.com/download/dotnet-core/2.1 2. dotnet core 2.2 的下载地址 https://dotnet.microsoft.com/download/dotnet-core/2.2 3. dotnet core3.0 的下载地址 https://dotnet.microsoft.com/download/dotnet-core/3.0 截止2019.2.19 时的

引用作者原话:Asp.Net的WebApi中使用Swagger作为说明和测试的页面是非常不错的,比起WebApiTestClient来至少在界面上的很大的提升.但是使用Swagger时如果只是一般的控制器直接放到Controller下就可以了,而如果因不同的业务需求而需要分类或者有同名的类名时时则没办法很好的处理. 因为业务需求需要创建域,但是Swagger 并未将域添加到接口.所以需要加上以下操作才行. 安装Swagger 方法:  为了大家多看微软官方文档.就直接引用Swagger安装及使用

dotnet core 2.2开发项目中,常会使用Swagger UI来生成在线Api文档. 某些接口不想放到Swagger中可以这样写Filter: /// <summary> /// 隐藏swagger接口特性标识 /// </summary> [System.AttributeUsage(System.AttributeTargets.Method | System.AttributeTargets.Class)] public partial class HiddenApi

Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.是一款RESTFUL接口的文档在线自动生成+功能测试软件.主要目的是构建标准的.稳定的.可重用的.交互式的API以及简单方便的功能测试.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步.Swagger 让部署管理和使用功能强大的API从未如此简单. 作用:     1. 根据基于规范的标准设计和建模API  

以前写的一个rest提供的是浏览器下载zip包的功能,前端界面调用rest可以正常地下载. 今天使用Swagger来调试下载功能时,发现下载的zip包打不开,而且大小也比直接在浏览器中输入rest地址下载的zip包要大. 浏览器中输入rest地址下载的zip包是好的,大小也是对的. rest的@ApiOperation注解的produces属性需要配置为"application/octet-stream" @ApiOperation(value = "下载zip",

asp.net core的wwwroot文件夹下默认时保存静态文件的地方,外面可以直接访问,但是如果是一些无法识别的后缀文件,如(.apk),会报错404 如果想要实现下载这些文件,在配置静态文件中间件时做如下设置: app.UseStaticFiles(new StaticFileOptions() { ServeUnknownFileTypes = true, DefaultContentType = "application/x-msdownload" });

1.本文章参考 点击链接跳转 改写的 一对多分组模式.需要一对一的可以参考 2.本文主要讲的是 一对多 分组公用, 同时把尚未分组的加载出来 3.效果演示GIF图: 具体操作代码如下: 1.在项目创建一个目录(ApiGroup),然后创建三个类,分别为ApiGroupAttribute.cs(控制器特性),ApiGroupNames.css(系统分组枚举),GroupInfoAttribute.cs(给系统分组枚举值增加相关信息的特性,这个主要是用于在Swagger分组时可关联Title,Ver

Swagger不用多说,可以自动生成Web Api的接口文档和客户端调用代码,方便开发人员进行测试.通常我们只需要几行代码就可以实现这个功能: ... builder.Services.AddSwaggerGen(); ... app.UseSwagger(); app.UseSwaggerUI(); ... 可如果使用Identity Server 4等认证服务对Web Api进行保护后,使用上面代码生成的Web Api文档就无法工作了,在进行测试时会提示401错误. 本文介绍如何使Swagg

net swagger接口 引用NuGet包 Install-Package Swashbuckle.AspNetCore //控制台 Microsoft.Extensions.PlatformAbstractions //包管理,用来获取xml根目录 Startup public void ConfigureServices(IServiceCollection services) { services.AddMvc().SetCompatibilityVersion(Compatibilit

因为场景需要,要把某些特定的api过滤掉,不允许显示在swaggerui里, 具体操作步骤: 分为三步 步骤1: 创建Attribute    /// <summary> /// ignore some api on swagger.json /// </summary> [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public class SwaggerIg

Startup中的  ConfigureServices //注册 Swagger services.AddSwaggerGen(sg => { sg.SwaggerDoc("refuge", new Swashbuckle.AspNetCore.Swagger.Info { Title = "我的第一个 Swagger", Version = "版本1" }); }); Configure 启用中间件 //启用 Swagger app.U

这里的数据显示 点击Download Templates下载之后是显示一个response流都不是一个xlsx文件 这个是由什么原因造成的,求解?

添加完Swagger包引用后运行报错:Actions require an explicit HttpMethod binding for Swagger 2.0 第一时间想到了父类控制器 没有添加 [HttpPost] 之类的特性 添加后就可以解决这个报错原因 但是我的父类控制器里的两个方法只是为了做返回值的一些处理,不应该包含这些特性.但又为了解决这个错误让swagger跑起来 所以加上 [NonAction] 即可.

基本swagger使用不再详解,具体百度其它帖子 1.将汉化的swagger js文件复制到项目根目录中 js代码如下 'use strict'; /** * Translator for documentation pages. * * To enable translation you should include one of language-files in your index.html * after <script src='lang/translator.js' type='t

开始之前,先介绍下swagger常用方法. services.AddSwaggerGen    //添加swagger中间件 c.SwaggerDoc  //配置swagger文档,也就是右上角的下拉框内容 c.IncludeXmlComments  //引用程序集xml,用于加载出 备注信息等如图 c.AddSecurityDefinition  //添加授权验证  c.DocInclusionPredicate    //核心方法,指定分组被加载时 回调进入,也就是swagger右上角下拉框

在Startup中 services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new Info { Title = "IMS API", Version = "v1" }); options.SwaggerDoc("v2", new Info { Title = "IMS API V2", Version = "v2"