即将推出的kbmMW更新不仅是一些bug修正,同时将包含一个新的主要功能:客户端存根生成器框架. 那什么是客户端存根生成器框架呢? 他是一个基于kbmMW smart services,可以生成由各种类型的客户端直接使用的代码,以访问基于kbmMW应用服务器的HTTP smart services.(什么是HTTP Smart Service呢?可参考洞主写的文章:kbmmw 的HTTP Smart Service入门) 当前,kbmMW已经实现智能客户端(smart client)功能,通过这…
我在前两篇文章中展示了“REST easy with kbmMW”文章,如何使用kbmMW制作REST服务器,以及如何使用该REST服务器轻松地从数据库返回和存储数据,所有这些都在不到30行的真实数据库中码. 此文章将围绕如何确保使用SSL(安全套接字层)保持与服务器的通信受到保护.换句话说,如何使REST服务器与HTTPS而不是HTTP进行通信. 有多种方法可以使用SSL保护基于kbmMW的应用程序服务器,但我将重点介绍使用OpenSSL执行此操作的一种简单方法. 首先,我们应该创建一个可以使…
介绍 关于如何使用授权和登录管理来构建应用服务器还存在一些问题,其中之一就是用户及其角色如何在在数据库中定义.该文将解释使用TkbmMWAuthorizationManager解决此问题的一种方法.有关其他的信息,可以参考前文REST easy with kbmMW #4 – Access management 首先,我们应该有一些需要登录支持的服务器.对于此示例,我选择了FishFact REST服务器.该服务器的实现可参考kbmMW #12 – Fishfact demo using HTT…
Swagger其实包含了三个部分,分别是Swagger Editor文档接口编辑器,根据接口文档生成code的Swagger Codegen,以及生成在线文档的Swagger UI.在AspNetCore中通常使用Microsoft封装的Swashbuckle来使用Swagger UI,这是一个AspNetCore的中间件.和其他中间件一样都是分为register和use两个部分.Swagger UI主要通过将特殊特性标注过的API信息生成一个OpenAPI的文档,再将文档上的信息已网页的形式显…
什么是Swagger? 说swagger 之前,我们先说一下OpenApi 规范. OpenApi 是一种和语言无关的用于描述RESTAPIs 接口功能的一种规范,对RESTAPIs 接口的描述包括: 接口参数信息.接口返回值信息.api 功能描述.请求路径等. 这里我们说OpenApi 只是一种规范,既然是一种规范,就必然有相应的实现,Swagger 就是其中一个实现了Open Api 规范的工具. .net 中RESTAPIs的代表便是 web api ,并且.net 针对Web Api 也…
Swagger大家都不陌生,Swagger (OpenAPI) 是一个与编程语言无关的接口规范,用于描述项目中的 REST API.它的出现主要是节约了开发人员编写接口文档的时间,可以根据项目中的注释生成对应的可视化接口文档. OpenAPI 规范 (openapi.json) OpenAPI 规范是描述 API 功能的文档.该文档基于控制器和模型中的 XML和属性注释.它是 OpenAPI 流的核心部分,用于驱动诸如 SwaggerUI 之类的工具. .NET 平台下的两个主要实现Swagge…
文档目录 本节内容: 简介 Asp.net Core 安装 安装Nuget包 配置 测试 Asp.net 5.x 安装 安装Nuget包 配置 测试 简介 来自它的网页:“...使用一个Swagger-enabled Api,你将获取交互文档,客户端SDK的创建和暴露.”. Asp.net Core 安装 基于Asp.net Core应用,你可以很方便的把Swagger集成到你的ABP里. 安装Nuget包 在你的Web项目里安装Swashbuckle包. 配置 在你的Startup.cs文件里…
返回总目录 本篇目录 介绍 安装 安装Nuget包 配置 测试 介绍 从官方网站上可以看到:"启用了Swagger API,就可以获得交互式文档,生成和发现客户端SDK". 安装 将Swagger集成到基于ABP的应用中是很容易的事情. 安装Nuget包 将Swashbuckle.Core Nuget包安装到WebApi项目(或Web项目)中. 配置 将Swagger的配置代码添加到模块的Initialize方法中.例如: public class SwaggerIntegration…
Swagger 是个好东西,对于前后端分离的网站来说,不仅是提高前后端开发人员沟通效率的利器,也大大方便了后端人员测试 API.有时候,API 中可能需要在 Header 中设置认证参数,比如 authToken,这样的功能我们通常是使用 ActionFilter 实现的,这就会导致 swagger UI 中缺少 authToken 字段,下面就来介绍解决这个问题的办法. 创建一个过滤器类,内容如下: /// <summary> /// this class is for swagger to…
在Abp中集成Swagger UI功能 1.安装Swashbuckle.Core包 通过NuGet将Swashbuckle.Core包安装到WebApi项目(或Web项目)中. 2.为WebApi方法添加注释,并生成xml 在xxx.Application项目的接口声明文件中为各接口方法添加注释,如下图: 编辑xxx.Application项目属性,设定在输出时生成XML文档文件 3.在xxx.WebApi项目中配置Swagger 修改xxxWebApiModule类,添加ConfigureSw…