《基于AspNet的json配置WebAPI》

本文主要是介绍《基于AspNet的json配置WebAPI》，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

项目简介

概述

• 基于C# ASP.NET 框架开发的WebAPI
• 通用的Json配置（无需创建配置参数类）
• IIS部署WebAPI，远程接口访问查询和修改配置
• 接口包括获取和修改json、通过key获取和修改json

项目环境

• VisualStudio 2019

• .Net 5.0

配置文件json示例

{"name": "tmp","id": 1001,"input": {"key1": 1.2,"key2": [1,2,3]},"output": {"key1": "val2","key2": 32}
}

Swagger

项目实施

json文件路径配置

• appsetting.json配置json文件路径

"ConfigPath": "./Config/config.json",

• 读取配置并注册服务

string configPath = configuration.GetValue<string>("ConfigPath");
services.AddSingleton<IConfigManager>(new ConfigManager(configPath));

接口类

• RemoteJsonConfigController
  • 查询返回字符串
  • 目前第一层key，嵌套key待实现
  • PUT接口，通过输入JsonElement 类实现json输入无需输入""， 参考

[HttpGet]
public IActionResult GetJsonFile()
{var json = _configManager.GetJsonFile();return Ok(json);
}[HttpGet("{key}")]
public IActionResult GetJsonByKey(string key)  
{var json = _configManager.GetJsonByKey(key);if (json==null){return StatusCode(400, $"[GetJsonByKey] {key} not exist!");}return Ok(json);
}[HttpPut]
public IActionResult UpdateJson([FromBody] JsonElement body)
{string json = System.Text.Json.JsonSerializer.Serialize(body);   // _configManager.UpdateJson(json);return Ok();
}[HttpPut("{key}")]
public IActionResult UpdateJsonByKey(string key, [FromBody] JsonElement body)
{_configManager.UpdateJsonByKey(key, body);return Ok();
}

接口实现

• ConfigManager.cs
  • UpdateJsonByKey中value的种类，主流已支持，具体还要再加一些
  • 整体还要加一下错误处理

public string GetJsonFile()
{string json = string.Empty;using (FileStream fs = new FileStream(_configPath, FileMode.Open, System.IO.FileAccess.Read, FileShare.Read)){using (StreamReader sr = new StreamReader(fs, Encoding.UTF8)){json = sr.ReadToEnd().ToString();}}return json;
}public string GetJsonByKey(string key)
{string json_key = null;using (FileStream fs = new FileStream(_configPath, FileMode.Open, System.IO.FileAccess.Read, FileShare.Read)){using (StreamReader sr = new StreamReader(fs, Encoding.UTF8)){var json = sr.ReadToEnd().ToString();JObject o = JObject.Parse(json);json_key = o[key] == null ? null : o[key].ToString();}}return json_key;
}public void UpdateJson(string json)
{using (FileStream fs = new FileStream(_configPath, FileMode.Create, System.IO.FileAccess.ReadWrite, FileShare.ReadWrite)){using (StreamWriter sw = new StreamWriter(fs, Encoding.UTF8)){sw.WriteLine(json);}}
}public bool UpdateJsonByKey(string key, JsonElement body)
{var json_all = GetJsonFile();if (json_all != null){JObject json_o = JObject.Parse(json_all);Console.WriteLine(json_o[key].Type);bool ret = true;switch (json_o[key].Type){case JTokenType.Integer:json_o[key] = body.GetInt64();break;case JTokenType.Float:json_o[key] = body.GetDouble();break;case JTokenType.Date:json_o[key] = body.GetDateTime();break;case JTokenType.Object:json_o[key] = JObject.Parse(System.Text.Json.JsonSerializer.Serialize(body));break;case JTokenType.String:json_o[key] = body.GetString();break;default:ret = false;break;}UpdateJson(json_o.ToString());return ret;}return false;
}

IIS部署

• 打开 【启用或关闭Windows功能】
  

• 搜索 【IIS】
  

• 右键——添加网站
  

• 设置

  • 网站名
  • 文件地址
  • 端口号
    • 80端口是电脑默认端口，输入可以不要输入端口直接访问
    • 端口不能重复

• 浏览网站，看看是否发布成功
  

• 或者直接输入

127.0.0.1:88/swagger
或者
localhost:88/swagger

接口

• 打开swagger

localhost:88/swagger

• 获取json配置(method=GET)

localhost:88/config

• 修改json(method=PUT)

localhost:88/config(method=GET)

• 按key获取json

localhost:88/config/name

• 按key修改json(method=PUT)

localhost:88/config/name

项目小结

• 一个简单的demo，实现起来很快，无需自己写处理json的server
• 可以自己写客户端UI来调这些接口，怕麻烦可以直接用swagger
• 配置文件采用通用json，处理以字符串形式来处理
• 错误处理，嵌套key还需再完善
• 工程文件地址，可简单参考

这篇关于《基于AspNet的json配置WebAPI》的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---