Swagger 实践 <二>
1. 新建.netCore WebApi 项目(选择Angular)。按照上一篇的加上Swage 文档,使http://localhost:11934/swagger/v1/swagger.json 可以访问。
2.新建 一个文件夹nswag,里面有3个文件
- refresh.bat : "..\node_modules\.bin\nswag" run
- service.config.nswag,注意修改地址
- {
- "runtime": "Default",
- "swaggerGenerator": {
- "fromSwagger": {
- "url": "http://localhost:11934/swagger/v1/swagger.json",
- "output": null
- }
- },
- "codeGenerators": {
- "swaggerToTypeScriptClient": {
- "className": "{controller}ServiceProxy",
- "moduleName": "",
- "namespace": "",
- "typeScriptVersion": 2.0,
- "template": "Angular",
- "promiseType": "Promise",
- "httpClass": "HttpClient",
- "useSingletonProvider": false,
- "injectionTokenType": "InjectionToken",
- "rxJsVersion": 6.0,
- "dateTimeType": "OffsetMomentJS",
- "nullValue": "Undefined",
- "generateClientClasses": true,
- "generateClientInterfaces": false,
- "generateOptionalParameters": false,
- "wrapDtoExceptions": false,
- "wrapResponses": false,
- "generateResponseClasses": true,
- "responseClass": "SwaggerResponse",
- "useTransformOptionsMethod": false,
- "useTransformResultMethod": false,
- "generateDtoTypes": true,
- "operationGenerationMode": "MultipleClientsFromPathSegments",
- "markOptionalProperties": false,
- "generateCloneMethod": true,
- "typeStyle": "Class",
- "extensionCode": "service.extensions.ts",
- "generateDefaultValues": true,
- "excludedTypeNames": [],
- "handleReferences": false,
- "generateConstructorInterface": true,
- "convertConstructorInterfaceData": false,
- "importRequiredTypes": true,
- "useGetBaseUrlMethod": false,
- "baseUrlTokenName": "API_BASE_URL",
- "queryNullValue": "",
- "output": "../src/shared/service-proxies/service-proxies.ts"
- },
- "swaggerToCSharpClient": {
- "generateClientClasses": true,
- "generateClientInterfaces": false,
- "generateDtoTypes": true,
- "injectHttpClient": false,
- "disposeHttpClient": true,
- "generateExceptionClasses": true,
- "exceptionClass": "SwaggerException",
- "wrapDtoExceptions": true,
- "useHttpClientCreationMethod": false,
- "httpClientType": "System.Net.Http.HttpClient",
- "useHttpRequestMessageCreationMethod": false,
- "useBaseUrl": true,
- "generateBaseUrlProperty": true,
- "generateSyncMethods": false,
- "exposeJsonSerializerSettings": false,
- "clientClassAccessModifier": "public",
- "typeAccessModifier": "public",
- "generateContractsOutput": false,
- "parameterDateTimeFormat": "s",
- "generateUpdateJsonSerializerSettingsMethod": true,
- "serializeTypeInformation": false,
- "queryNullValue": "",
- "className": "{controller}Client",
- "operationGenerationMode": "MultipleClientsFromOperationId",
- "generateOptionalParameters": false,
- "generateJsonMethods": true,
- "parameterArrayType": "System.Collections.Generic.IEnumerable",
- "parameterDictionaryType": "System.Collections.Generic.IDictionary",
- "responseArrayType": "System.Collections.ObjectModel.ObservableCollection",
- "responseDictionaryType": "System.Collections.Generic.Dictionary",
- "wrapResponses": false,
- "generateResponseClasses": true,
- "responseClass": "SwaggerResponse",
- "namespace": "MyNamespace",
- "requiredPropertiesMustBeDefined": true,
- "dateType": "System.DateTime",
- "dateTimeType": "System.DateTime",
- "timeType": "System.TimeSpan",
- "timeSpanType": "System.TimeSpan",
- "arrayType": "System.Collections.ObjectModel.ObservableCollection",
- "dictionaryType": "System.Collections.Generic.Dictionary",
- "arrayBaseType": "System.Collections.ObjectModel.ObservableCollection",
- "dictionaryBaseType": "System.Collections.Generic.Dictionary",
- "classStyle": "Inpc",
- "generateDefaultValues": true,
- "generateDataAnnotations": true,
- "excludedTypeNames": [],
- "handleReferences": false,
- "generateImmutableArrayProperties": false,
- "generateImmutableDictionaryProperties": false,
- "output": null
- },
- "swaggerToCSharpController": {
- "controllerStyle": "Partial",
- "useCancellationToken": false,
- "aspNetNamespace": "System.Web.Http",
- "className": "{controller}",
- "operationGenerationMode": "MultipleClientsFromOperationId",
- "additionalNamespaceUsages": [
- "System.Web.Http"
- ],
- "generateOptionalParameters": false,
- "generateJsonMethods": true,
- "parameterArrayType": "System.Collections.Generic.IEnumerable",
- "parameterDictionaryType": "System.Collections.Generic.IDictionary",
- "responseArrayType": "System.Collections.ObjectModel.ObservableCollection",
- "responseDictionaryType": "System.Collections.Generic.Dictionary",
- "wrapResponses": false,
- "generateResponseClasses": true,
- "responseClass": "SwaggerResponse",
- "namespace": "MyNamespace",
- "requiredPropertiesMustBeDefined": true,
- "dateType": "System.DateTime",
- "dateTimeType": "System.DateTime",
- "timeType": "System.TimeSpan",
- "timeSpanType": "System.TimeSpan",
- "arrayType": "System.Collections.Generic.IEnumerable",
- "dictionaryType": "System.Collections.Generic.Dictionary",
- "arrayBaseType": "System.Collections.ObjectModel.ObservableCollection",
- "dictionaryBaseType": "System.Collections.Generic.Dictionary",
- "classStyle": "Inpc",
- "generateDefaultValues": true,
- "generateDataAnnotations": true,
- "excludedTypeNames": [],
- "handleReferences": false,
- "generateImmutableArrayProperties": false,
- "generateImmutableDictionaryProperties": false,
- "output": null
- }
- }
- }
- {
- service.extensions.ts :import 'rxjs/add/operator/finally';
3.在package.json 中添加 "nswag": "^11.18.6"
执行 npm install .如果安装不上,可以改变下仓库:npm set registry https://registry.npm.taobao.org/ 参考这里
4. 运行后端。
双击运行nswag 下的refresh.bat 就可以生成 service-proxies.ts
5.原理跟踪:
- .\node_modules\.bin\nswag 如下;
- @IF EXIST "%~dp0\node.exe" (
- "%~dp0\node.exe" "%~dp0\..\nswag\bin\nswag.js" %*
- ) ELSE (
- @SETLOCAL
- @SET PATHEXT=%PATHEXT:;.JS;=;%
- node "%~dp0\..\nswag\bin\nswag.js" %*
- )
- @IF EXIST "%~dp0\node.exe" (
- nswag.js:
- #!/usr/bin/env node
- "use strict";
- var defaultCoreVersion = "";
- var supportedCoreVersions = ["", "", "", ""];
- // Initialize
- process.title = 'nswag';
- console.log("NSwag NPM CLI");
- var args = process.argv.splice(, process.argv.length - ).map(function (a) { return a.indexOf(" ") === - ? a : '"' + a + '"' }).join(" ");
- // Legacy support
- args = args.replace("--x86", "/runtime:WinX86");
- args = args.replace("/runtime:x86", "/runtime:WinX86");
- args = args.replace("--core 1.0", "/runtime:NetCore10");
- args = args.replace("--core 1.1", "/runtime:NetCore11");
- args = args.replace("--core 2.0", "/runtime:NetCore20");
- args = args.replace("--core 2.1", "/runtime:NetCore21");
- args = args.replace("--core", "/runtime:NetCore" + defaultCoreVersion);
- // Search for full .NET installation
- var hasFullDotNet = false;
- var fs = require('fs');
- if (process.env["windir"]) {
- try {
- var stats = fs.lstatSync(process.env["windir"] + '/Microsoft.NET');
- if (stats.isDirectory())
- hasFullDotNet = true;
- }
- catch (e) {
- console.log(e);
- }
- }
- var c = require('child_process');
- if (hasFullDotNet && args.toLowerCase().indexOf("/runtime:netcore") == -) {
- // Run full .NET version
- if (args.toLowerCase().indexOf("/runtime:winx86") != -) {
- var cmd = '"' + __dirname + '/binaries/Win/nswag.x86.exe" ' + args;
- var code = c.execSync(cmd, { stdio: [, , ] });
- } else {
- var cmd = '"' + __dirname + '/binaries/Win/nswag.exe" ' + args;
- var code = c.execSync(cmd, { stdio: [, , ] });
- }
- } else {
- // Run .NET Core version
- var defaultCmd = 'dotnet "' + __dirname + '/binaries/NetCore' + defaultCoreVersion + '/dotnet-nswag.dll" ' + args;
- var infoCmd = "dotnet --version";
- c.exec(infoCmd, (error, stdout, stderr) => {
- for (let version of supportedCoreVersions) {
- var coreCmd = 'dotnet "' + __dirname + '/binaries/NetCore' + version + '/dotnet-nswag.dll" ' + args;
- if (args.toLowerCase().indexOf("/runtime:netcore" + version) != -) {
- c.execSync(coreCmd, { stdio: [, , ] });
- return;
- } else {
- if (!error) {
- var coreVersion = stdout;
- if (coreVersion.indexOf(version + ".0") !== -) {
- c.execSync(coreCmd, { stdio: [, , ] });
- return;
- }
- }
- }
- }
- c.execSync(defaultCmd, { stdio: [, , ] });
- return;
- });
- }
Swagger 实践 <二>的更多相关文章
- ASP.NET MVC5 网站开发实践(二) Member区域–管理列表、回复及删除
本来想接着上次把这篇写完的,没想到后来工作的一些事落下了,放假了赶紧补上. 目录: ASP.NET MVC5 网站开发实践 - 概述 ASP.NET MVC5 网站开发实践(一) - 项目框架 ASP ...
- ASP.NET MVC5 网站开发实践(二) Member区域–我的咨询列表及添加咨询
上次把咨询的架构搭好了,现在分两次来完成咨询:1.用户部分,2管理部分.这次实现用户部分,包含两个功能,查看我的咨询和进行咨询. 目录: ASP.NET MVC5 网站开发实践 - 概述 ASP.NE ...
- ASP.NET MVC5 网站开发实践(二) Member区域 - 咨询管理的架构
咨询.留言.投诉等功能是网站应具备的基本功能,可以加强管理员与用户的交流,在上次完成文章部分后,这次开始做Member区域的咨询功能(留言.投诉都是咨询).咨询跟文章非常相似,而且内容更少.更简单. ...
- ASP.NET MVC5 网站开发实践(二) Member区域 - 修改及删除文章
上次做了显示文章列表,再实现修改和删除文章这部分内容就结束了,这次内容比较简单,由于做过了添加文章,修改文章非常类似,就是多了一个TryUpdateModel部分更新模型数据. 目录: ASP.N ...
- ASP.NET MVC5 网站开发实践(二) Member区域 - 全部文章列表
显示文章列表分两块,管理员可以显示全部文章列表,一般用户只显示自己的文章列表.文章列表的显示采用easyui-datagrid.后台需要与之对应的action返回json类型数据 目录 ASP.N ...
- ASP.NET MVC5 网站开发实践(二) Member区域 - 添加文章
上次把架构做好了,这次做添加文章.添加文章涉及附件的上传管理及富文本编辑器的使用,早添加文章时一并实现. 要点: 富文本编辑器采用KindEditor.功能很强大,国人开发,LGPL开源,自己人的好东 ...
- ASP.NET MVC5 网站开发实践(二) Member区域 - 文章管理架构
上次把member的用户部分完成,现在开始做文章管理部分.文章部分根据涉及显示现实文章列表,发布文章,修改文章,删除文章等功能.最终的实现目标是使用权限来控制用户是否能进行相应操作,管理员权限的会显示 ...
- ASP.NET MVC5 网站开发实践(二) Member区域 - 用户部分(3)修改资料、修改密码
在上一篇博客中实现了用户的注销和登录,其实代码里落了点东西,就是用户登录要更新最后一次登录时间和登录IP,这次补上.今天做修改资料和修改密码,TryUpdateModel是新用到的东西. 目录: AS ...
- ASP.NET MVC5 网站开发实践(二) Member区域 - 用户部分(2)用户登录、注销
上次实现了用户注册,这次来实现用户登录,用到IAuthenticationManager的SignOut.SignIn方法和基于声明的标识.最后修改用户注册代码实现注册成功后直接登录. 目录: ASP ...
随机推荐
- 灵活使用ssh、dsh和pssh高效管理大量计算机
http://os.iyunv.com/art/201012/240113.htm 灵活使用ssh.dsh和pssh高效管理大量计算机 http://os.iyunv.com2010-12-23 09 ...
- error: cannot connect to daemon解决办法
本文链接:https://blog.csdn.net/ipinki1218/article/details/80704806运行adb shell时出现error: cannot connect to ...
- 数字图像处理--算术、几何、谐波、逆谐波均值滤波器Matlab
本文链接:https://blog.csdn.net/Dooonald/article/details/78545461算术均值 close all clear all f=imread('D:/te ...
- 技术干货丨如何在VIPKID中构建MQ服务
小结: 1. https://mp.weixin.qq.com/s/FQ-DKvQZSP061kqG_qeRjA 文 |李伟 VIPKID数据中间件架构师 交流微信 | datapipeline201 ...
- vue页面刷新重定向
在App.vue中,添加如下代码: created(){ if(this.$router.path !== '/RealTimeMonitoring'){ this.$router.replace(' ...
- ISO/IEC 9899:2011 条款5——5.2.2 字符显示语义
5.2.2 字符显示语义 1.活动位置是在一个显示设备上的位置,由fputc函数所输出的下一个字符会出现在那个位置上.写一个打印字符(由isprint函数)到显示设备的意图是为了在活动位置上显示那字符 ...
- Qt编写自定义控件40-导航进度条
一.前言 导航进度条控件,其实就是支付宝.京东.淘宝订单页面的进度控件,提示当前第几步,总共有几步,然后当前进度特殊颜色显示,每个进度带有时间文字等信息,本控件特意将三种样式风格都集成进去了,京东订单 ...
- JEECG中修改时间相关自定义定时器
JEECG中使用,如下: @InitBinder public void initBinder(ServletRequestDataBinder binder) { binder.registerCu ...
- 01.轮播图之四 :imageViews(2 或者 3 个imageview) 轮播
首先说下 3 个imageView的轮播,这个逻辑分析起来 比较简单, 先上传个图片吧::::: 主要分析起来,核心就是这样 :新的图片永远是加在中间ImageView上的,下一轮的第一张图片,是上一 ...
- 如何禁用maven下载进度指示?
方法 mvn -B ..或者mvn --batch-mode ...