注释玩转webapi

using System; using System.Collections.Generic; using System.Net.Http.Formatting; using System.Web.Http; namespace MvcTest { public static class WebApiConfig { public static void Register(HttpConfiguration config) { //定义路由以支持action //实际开发建议使用此方式 conf…

.NET WebAPI 用ActionFilterAttribute实现token令牌验证与对Action的权限控制

项目背景是一个社区类的APP(求轻吐...),博主主要负责后台业务及接口.以前没玩过webAPI,但是领导要求必须用这个(具体原因鬼知道),只好硬着头皮上了. 最近刚做完权限这一块,分享出来给大家.欢迎各种吐槽批判践踏... 先说说用户身份的识别,简单的做了一个token机制.用户登录,后台产生令牌,发放令牌,用户携带令牌访问... 1.cache管理类,由于博主使用的HttpRuntime.Cache来存储token,IIS重启或者意外关闭等情况会造成cache清空,只好在数据库做了cache…

WebAPI 用ActionFilterAttribute实现token令牌验证与对Action的权限控制

.NET WebAPI 用ActionFilterAttribute实现token令牌验证与对Action的权限控制项目背景是一个社区类的APP(求轻吐...),博主主要负责后台业务及接口.以前没玩过webAPI,但是领导要求必须用这个(具体原因鬼知道),只好硬着头皮上了. 最近刚做完权限这一块,分享出来给大家.欢迎各种吐槽批判践踏... 先说说用户身份的识别,简单的做了一个token机制.用户登录,后台产生令牌,发放令牌,用户携带令牌访问... 1.cache管理类,由于博主使用的HttpR…

JSON数据源提供多值参数的实现

一.应用场景 (1)报表的数据内容需要根据某个参数进行过滤. (2)该参数是一个多值参数,即从一个下拉列表中选择一个或多个项目. (3)报表需要自动运行,因此参数必须有默认值. (4)参数默认值无法在设计报表时就确定下来. 二.实现方案问题的核心是:报表自动运行是无人值守的,没有人机交互的机会,因此"必需性(Required)"报表参数必须有默认值,但是某些报表的参数取值是与业务系统有关的,无法在设计报表模板时就确定好参数的默认值. 解决这一问题的思路是:编写一个Web Servic…

项目梳理4——WebApi项目，使用注释填充Description字段

web.config中添加连接字符串: 为webapi添加Description,使用注释来填充此字段对于所有引用的xxxx.base项目设置生成的xml文档,注意release.debug下都需设置,并重新生成 xxxxx.WebApi\Areas\HelpPage\XmlDocumentationProvider.cs中,添加构造函数,用于解析xml文件: /// <summary> /// Initializes a new instance of the <see cref=&…

swagger webapi控制器注释不显示

swagger是webapi文档描述及调试工具,要在asp.net mvc中使用swagger,需要安装Swashbuckle.Core这个包,安装好后会在app_start中生成SwaggerConfig.cs文件,修改Register方法在文件中指定webapi项目生成的xml文件所在路径,详细配置请参考 https://github.com/domaindrivendev/Swashbuckle using System.Web.Http; using WebActivatorEx; us…

如何新建WebAPI，生成注释，TestAPI的项目

一.新建WebAPI的项目 1. 在Web下,ASP.NET Web 应用程序,点击确定 2. 点击确定 3. 如图所示, 新建Controller 4 . 运行项目二.注释 1. 在生成中,勾选xml文档文件(生成注释文件) 2. 修改HelpPageCofig,添加项目的APl.xml的配置 config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath(@"bi…

Word 查找替换高级玩法系列之 -- 把论文中的缩写词快速变成目录下边的注释表

1. 前言问题:Word写论文如何把文中的缩写快速转换成注释表? 原来样子: 想要的样子: 2. 步骤使用查找替换高级用法,替换缩写顺序选中所有文字打开查找替换对话框,输入以下表达式: 替换后样子: 上边用到的两行表达式: 查找内容:([一-龥a-zA-Z]@)([(])([a-zA-Z -]@)(,)([A-Za-z]@)([)]) 替换为:\5#\3,\1 表达式解释: 忽略缩写的具体内容,只看格式,比如:信息和通信技术(Information and Communication T…

ASP.NET Core WebApi使用Swagger生成API说明文档【xml注释版】

⒈新建ASP.NET Core WebAPi项目 ⒉添加 NuGet 包 Install-Package Swashbuckle.AspNetCore ⒊Startup中配置 using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Ho…

Dynamics CRM 365中结合注释和WebApi实现图片上传

首先需要在实体上使用注释,然后在窗体上引用WebResource. WebResource的代码: <!DOCTYPE html> <html> <head> <title>上传图片</title> <style> ul, li { list-style: none; margin: 0; } .image-list { margin-top: 6px; overflow: hidden; padding-left: 0; } .im…

[置顶] 玩转Eclipse — 自动注释插件JAutodoc

代码注释是一种良好的编程习惯.不管对于他人还是自己,注释都有助于代码的阅读和理解.手动添加注释,是一个非常费时和繁琐的工作,严重影响软件开发效率,这也是绝大多数程序员不愿添加注释的主要原因.JAutodoc是一款Eclipse插件,主要用于在源代码文件中自动添加Javadoc和文件头.它使用Velocity templates模板,并依据元素名称生成相应的初始注释. 1. 安装 Eclipse菜单栏上选择 Help -> Install New Software...,进入如下安装界面: 点击“…

我这么玩Web Api（二）：数据验证，全局数据验证与单元测试

目录一.模型状态 - ModelState 二.数据注解 - Data Annotations 三.自定义数据注解四.全局数据验证五.单元测试一.模型状态 - ModelState 我理解的ModelState是微软在ASP.NET MVC中提出的一种新机制,它主要实现以下几个功能: 1. 保存客户端传过来的数据,如果验证不通过,把数据返回到客户端,这样可以保存用户输入,不需要重新输入. 2. 验证数据,以及保存数据对应的错误信息. 3. 微软的一种DRY(Don't Repeat…

ExceptionLess新玩法 -- 审计日志

审计日志这算是一个挺酷的功能,把每个请求都记录下来,之前在abp中看到过这个功能,配合可视化的界面,简直是在装逼看到了exceptionless后,心念一动,我也可以根据它做一个审计日志的功能.这里需要一些MVC过滤器的知识,不同的同学请谷歌查一下资料. Next 使用过滤器, 在action执行完毕后执行此方法,首先创建一个attribute继承自ActionFilterAttribute重写OnActionExecuted方法,使用action名称做为Message使用Controlle…

webAPI 自动生成帮助文档

之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下. 先看一下生成的webapi文档. 1.下图展示的是生成帮助文档首页面,其中Values是controller,API下面的列表展示出请求的http方法(Get,POST等),请求的action,方法的描述. 2.点击红框内的链接,打开api方法的详情页面,如下图所示, 3.点击Test API打开如下页面 4.输入参数,点击S…

asp.net webAPI 自动生成帮助文档并测试

写给新手的WebAPI实践

此篇是写给新手的Demo,用于参考和借鉴,用于发散思路.老鸟可以忽略了. 自己经常有这种情况,遇到一个新东西或难题,在了解和解决之前总是说“等搞定了一定要写篇文章记录下来”,但是当掌握了之后,就感觉好简单呀不值得写下来了.其实这篇也一样,决定写下来是想在春节前最后再干一件正经事儿,不能天天回去打Dota了! 目录: 请求响应的设计请求的Content-Type和模型绑定自定义ApiResult和ApiControllerBase 权限验证模型生成文档生成一.请求响应的设计 RESTFu…

C# WebAPI中使用Swagger

随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染.前后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远. 前端和后端的唯一联系变成了API接口:API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架. 其他API文档工具没有API文档工具之前,大家都是手写API文档的,在什么地方书写的都有,有在confluence上写的,有在对应的项目目录下readme.md上写的,每个公司都有每个公司的玩法,无所谓…

C#中缓存的使用 ajax请求基于restFul的WebApi(post、get、delete、put) 让 .NET 更方便的导入导出 Excel .net core api +swagger(一个简单的入门demo 使用codefirst+mysql) C# 位运算详解 c# 交错数组 c# 数组协变 C# 添加Excel表单控件（Form Controls） C#串口通信程序

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

Webservice WCF WebApi 前端数据可视化前端数据可视化 C# asp.net PhoneGap html5 C# Where 网站分布式开发简介 EntityFramework Core依赖注入上下文方式不同造成内存泄漏了解一下？ SQL Server之深入理解STUFF 你必须知道的EntityFramework 6.x和EntityFramework Cor

Webservice WCF WebApi 注明:改编加组合在.net平台下,有大量的技术让你创建一个HTTP服务,像Web Service,WCF,现在又出了Web API.在.net平台下,你有很多的选择来构建一个HTTP Services.我分享一下我对Web Service.WCF以及Web API的看法. Web Service 1.它是基于SOAP协议的,数据格式是XML 2.只支持HTTP协议 3.它不是开源的,但可以被任意一个了解XML的人使用 4.它只能部署在IIS上 W…

net core Webapi基础工程搭建（七）——小试AOP及常规测试_Part 2

目录前言引入自定义属性测试小结前言前一篇讲到了中间层的使用,可能不是那么AOP,今天主要来说下一个轻量级的AOP第三方类库AspectoCore. 简单介绍下这个类库,AspectCore Project 是适用于 net core 平台的轻量级 Aop(Aspect-oriented programming) 解决方案,它更好的遵循 net core 的模块化开发理念,使用AspectCore可以更容易构建低耦合.易扩展的Web应用程序. 引入首先,我们在Util层直接引入相关…

整理下webapi的一些琐碎事情

在使用webapi的时候我们会遇到一些问题比如 1.POST怎么请求 2.怎么兼容JSONP请求 3.怎么给指定端提供跨域的请求 4.怎么显示单独的models层的注释问题一二其他人都玩的比较成熟的,百度一下千千万万的答案. 这篇文章来说一下问题4 说步骤就行了, 也不想打字反正是别人那里抄袭的直接上原文 http://stackoverflow.com/questions/21895257/how-can-xml-documentation-for-web-api-include-docum…

.Net Core3.0 WebApi 项目框架搭建二:API 文档神器 Swagger

.Net Core3.0 WebApi 项目框架搭建:目录为什么使用Swagger 随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染.后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远. 前端和后端的唯一联系,变成了API接口:API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架. 没有API文档工具之前,大家都是手写API文档的,在什么地方书写的都有,有在confluence上写的,有在对应的项目…

Taurus.MVC 2.0 开源发布：WebAPI开发教程

背景: 有用户反映,Tausus.MVC 能写WebAPI么? 能! 教程呢? 嗯,木有! 好吧,刚好2.0出来,就带上WEBAPI教程了! 开源地址: https://github.com/cyq1162/taurus.mvc 下面为教程: 步骤一:新建ASP.NET Web应用程序:WebAPI项目步骤二:Nuget上引用Taurus.MVC 安装后,框架默认引入两个Taurus.Core.dll和CYQ.Data.dll,以及自动配置web.config 步骤三:新建一个Controll…

[C#] 软硬结合第二篇——酷我音乐盒的逆天玩法

1.灵感来源: LZ是纯宅男,一天从早上8:00起一直要呆在电脑旁到晚上12:00左右吧~平时也没人来闲聊几句,刷空间暑假也没啥动态,听音乐吧...~有些确实不好听,于是就不得不打断手头的工作去点击下一曲或是找个好听的歌来听...但是,[移动手锁定鼠标-->移动鼠标关闭当前页面选择音乐软件页面-->选择合适的音乐-->恢复原来的界面] 这一过程也会烦人不少,如果说软件的设计要在用户体验上做足功夫,感觉这一点是软件设计人员很难管住的方面,毕竟操作系统也就这样安排的嘛(当然,有些机智的开发人…

ASP.NET MVC5+EF6+EasyUI 后台管理系统（66）-MVC WebApi 用户验证 (2)

系列目录前言: 回顾上一节,我们利用webapi简单的登录并进行了同域访问与跨域访问来获得Token,您可以跳转到上一节下载代码来一起动手. 继续上一篇的文章,我们接下来演示利用拿到的Token来访问接口,管理接口,利用系统权限管理接口,对每个接口进行授权(管理接口为选读部分,因为你需要阅读最开始权限管理部分(18-27节),才能阅读这部分) 开发环境: VS2015+无数据库(模拟数据) 样例代码下载访问密码 8ca3 知识点: WebApi权限验证应用到实际中来调试开始: 1.…

我这么玩Web Api（一）：帮助页面或用户手册(Microsoft and Swashbuckle Help Page)

前言你需要为客户编写Api调用手册?你需要测试你的Api接口?你需要和前端进行接口对接?那么这篇文章应该可以帮到你.本文将介绍创建Web Api 帮助文档页面的两种方式,Microsoft Help Page和Swashbuckle Help Page. 编写RESTful的Web Api /// <summary> /// 股票数据接口 /// </summary> [RoutePrefix("api/stocks")] public class Stock…

ABP项目中使用Swagger生成动态WebAPI

本文是根据角落的白板报的<使用ABP实现SwaggerUI,生成动态webapi>一文的学习总结,感谢原文作者角落的白板报. 1 安装Swashbuckle.core 1.1 选择WebApi项目,右键"管理NuGet程序包". 1.2 输入 "Swashbuckle.core",搜索.选择Swashbuckle.core,右边点击安装. 2 配置Swashbuckle 2.1 打开WebApi项目中的DemoWebApiModule.cs文件.创建Co…

ASP.NET Linux部署(2) - MS Owin + WebApi + Mono + Jexus

ASP.NET Linux部署(2) - MS Owin + WebApi + Mono + Jexus 本文承接我的上一篇博文: ASP.NET 5 Linux部署,那篇文章主要是针对最新的ASP.NET 5的,但在随后的研究中,我对这种娱乐型的部署依然不是非常满意,当然其主要原因是因为ASP.NET 5 依然处于RC版本,并不十分成熟. 但可以预见到的是,就算本月ASP.NET 5 RTM版本如期推出,其在Linux上面的开发和部署前景依然不是非常明朗: 特别令人困惑的是,MS在Linux上…

ABP教程-给项目添加SwaggerUI,生成动态webapi

上一篇,我们是正式将ABP生成的代码项目,跑起来了,然后演示了下多租户的不同.那么这篇我们就来实现下SwaggerUI. Q:SwaggerUI是干什么的呢? A:他是一个能将我们的webapi,通过Swagger Api来生成一个交互式的文档.通过他可以对你的接口进行调式. 1.引入Swashbuckle.core 选择PhoneBook.WebApi,然后添加nuget包(当然你也可以通过命令行添加). 输入"Swashbuckle.core" 引入到我们的项目中. 打开项目中的…

[.NET] WebApi 生成帮助文档及顺便自动创建简单的测试工具

==========最终的效果图========== ==========下面开始干活:生成帮助文档========== 一.创建 WebApi 项目二.找到 HelpPageConfig.cs 并取消代码注释 config.SetDocumentationProvider( new XmlDocumentationProvider ( HttpContext.Current.Server.MapPath( "~/App_Data/XmlDocument.xml" ))); 三.对项…

【注释玩转webapi】的更多相关文章