NSwag.AspNetCore常用功能介绍

对于asp.net core 下的Swagger,之前一直用Swashbuckle的,因为官方推荐,再加上有老张的博客助力《从壹开始前后端分离【 .NET Core2.0/3.0 +Vue2.0 】框架之三 || Swagger的使用 3.1》,所以用起来很顺手,但Swashbuckle有个问题,一直没解决,就是如果你的网站不是部署在根目录的话,是部署IIS在虚拟应用程序下的话,那Swagger就用不了了,不知有没有朋友有解决的方法,后面我试用了NSwag,发现它可以用在虚拟应用程序下,也是微软官方推荐的,多方比对,就采用了NSwag.AspNetCore。

使用方法,很简单,按微软官网介绍的入门方法,如下图

我这个博客基础的我就不写出来了,写几点常用功能

实现登录认证token的输入

现在的前后端分享项目,主要采用在header里添加token来进行身份认证,那如何在NSwag的Swagger上面实现这个功能呢。代码如下

services.AddOpenApiDocument(settings =>
{
  settings.AddSecurity("身份认证Token", Enumerable.Empty<string>(), new NSwag.OpenApiSecurityScheme()
  {
    Description = "JWT授权(数据将在请求头中进行传输) 直接在下框中输入Bearer {token}(注意两者之间是一个空格)",
    Name = "Authorization",
    In = NSwag.OpenApiSecurityApiKeyLocation.Header,
    Type = NSwag.OpenApiSecuritySchemeType.ApiKey
  });
});

实现效果如下图

实现控制器及接口的注释

接口方法的注释很容易,跟Swashbuckle基本一样,在项目的属性里勾选生成xml文档。

然后在方法上这样注释就可以实现接口说明了。

但控制器的注释说明就不像Swashbuckle那么方便了,它得用一个特性类OpenApiTag,如下图所示

最终实现效果如下

原文地址:https://www.cnblogs.com/caijt/p/11875905.html

时间: 2024-10-02 07:56:59

NSwag.AspNetCore常用功能介绍的相关文章

keepalived高可用的常用功能介绍

Keepalived的作用是检测web服务器的状态,如果有一台web服务器死机,或工作出现故障,Keepalived将检测到,并将有故障的web服务器从系统中剔除,当web服务器工作正常后Keepalived自动将web服务器加入到服务器群中,这些工作全部自动完成,不需要人工干涉,需要人工做的只是修复故障的web服务器.本篇文章会介绍keepalived的安装,配置,还有keepalived的一些脚本,keepalived+nginx高可用实现和keepalived双机互为主从的实现. keep

Dreamweaver简明手册——常用功能介绍

1.概述 Dreamweaver 是一款集网页制作和管理网站于一身的所见即所得网页编辑器,在开发前端视图页面的时候,用这个工具,能让代码更清晰化,界面更整洁,可以大大的提升Web前端开发效率.基于数通畅联的AEAI DP开发平台可以直接生成JSP前端页面,通常在AEAI DP中使用JSP编辑器编辑JSP页面,但是JSP编辑器强于在JSP页面上写JAVA代码片段,但调整页面里的表单元素以及CSS样式等不方便,因此,一般采用AEAI D跟Dreamweaver配合进行前端JSP页面扩展开发.本文对D

WebPack常用功能介绍

概述 Webpack是一款用户打包前端模块的工具.主要是用来打包在浏览器端使用的javascript的.同时也能转换.捆绑.打包其他的静态资源,包括css.image.font file.template等.个人认为它的优点就是易用,而且常用功能基本都有,另外可以通过自己开发loader和plugin来满足自己的需求.这里就尽量详细的来介绍下一些基本功能的使用. 上一篇已经介绍如何安装了,这里就不再重复了. 运行webpack webpack需要编写一个config文件,然后根据这个文件来执行需

[转]WebPack 常用功能介绍

概述 Webpack是一款用户打包前端模块的工具.主要是用来打包在浏览器端使用的javascript的.同时也能转换.捆绑.打包其他的静态资源,包括css.image.font file.template等.个人认为它的优点就是易用,而且常用功能基本都有,另外可以通过自己开发loader和plugin来满足自己的需求.这里就尽量详细的来介绍下一些基本功能的使用. 安装 npm install webpack 运行webpack webpack需要编写一个config文件,然后根据这个文件来执行需

Android Studio 常用功能介绍

Android Studio 的基本用法 界面介绍 讲解1 这个界面,显示了我们使用 Android Studio时经常接触到的功能面板. Project 面板.用于浏览项目文件. Project 面板会显示当前的所有的 module . android application module 会显示一个手机图标(下图中的 app ):android library module 会显示一个书架图标(下图中的 android-lib):java library module 会显示一个咖啡图标(下

PowerDesigner常用功能介绍

PowerDesigner常用功能:1:把SQL脚步导入PowerDesigner打开powerdesigner,选择File --> Reverse Engineer --> Database……Model name随便写,我填的是wpblog,DBMS选MySQL 5.0然后确定 在Selection选项卡中选:Using scripts files:添加刚才的导出的sql脚本(wpblog.sql)Options选项卡中的File Encoding 选择:UTF8+QuickDetect

Android开发自学笔记&mdash;1.1(番外)AndroidStudio常用功能介绍

一.界面区介绍 1.项目组织结构区,用于浏览项目文件,默认Project以Android组织方式展示. 2.设计区,默认在打开布局文件时为设计模式,可直接拖动控件到界面上实现所见即所得,下方的Design和Text就是代码和设计模式的切换按钮,切换至TEXT时,左侧为代码编辑区,右侧为所见即所得的预览. 下图为切换至TEXT的界面 而我们常用的代码编辑时的界面就很简单,左边项目树,右侧代码编辑区,下图为代码编辑界面: 3.组件树,用于展示整个页面布局的层级关系. 4.属性区,显示选中控件的可编辑

Android开发自学笔记—1.1(番外)AndroidStudio常用功能介绍

一.界面区介绍 1.项目组织结构区,用于浏览项目文件,默认Project以Android组织方式展示. 2.设计区,默认在打开布局文件时为设计模式,可直接拖动控件到界面上实现所见即所得,下方的Design和Text就是代码和设计模式的切换按钮,切换至TEXT时,左侧为代码编辑区,右侧为所见即所得的预览. 下图为切换至TEXT的界面 而我们常用的代码编辑时的界面就很简单,左边项目树,右侧代码编辑区,下图为代码编辑界面: 3.组件树,用于展示整个页面布局的层级关系. 4.属性区,显示选中控件的可编辑

【linux_笔记】Linux_vim编辑器常用功能介绍

学习资源来自:www.magedu.com 学习记录过程中难免出现错误,如有发现,还望大神们指出. 示例操作部分有的与历史操作有关,如果先前的示例操作没有执行过的话,可能会有部分示例的操作无法执行.示例仅供参考. vim编辑器 vi: Visual Interface(可视化接口)vim: VI iMproved(vi升级版) vim:文本编辑器,字处理器,全屏编辑器,模式化编辑器(在不同的模式下,相同的击键动作被解释的意义不同) vim模式:    编辑模式(命令模式)    输入模式