《基于AspNet的json配置WebAPI》

2024-05-24 07:58
文章标签 配置 json webapi aspnet

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

文章目录

  • 项目简介
    • 概述
    • 项目环境
    • 配置文件`json`示例
    • Swagger
  • 项目实施
    • json文件路径配置
    • 接口类
    • 接口实现
    • IIS部署
    • 接口
  • 项目小结

项目简介

概述

  • 基于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
    • UpdateJsonByKeyvalue的种类,主流已支持,具体还要再加一些
    • 整体还要加一下错误处理
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》的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/997825

相关文章

nginx 负载均衡配置及如何解决重复登录问题

《nginx负载均衡配置及如何解决重复登录问题》文章详解Nginx源码安装与Docker部署,介绍四层/七层代理区别及负载均衡策略,通过ip_hash解决重复登录问题,对nginx负载均衡配置及如何... 目录一:源码安装:1.配置编译参数2.编译3.编译安装 二,四层代理和七层代理区别1.二者混合使用举例

Java JDK1.8 安装和环境配置教程详解

《JavaJDK1.8安装和环境配置教程详解》文章简要介绍了JDK1.8的安装流程,包括官网下载对应系统版本、安装时选择非系统盘路径、配置JAVA_HOME、CLASSPATH和Path环境变量,... 目录1.下载JDK2.安装JDK3.配置环境变量4.检验JDK官网下载地址:Java Downloads

Linux下进程的CPU配置与线程绑定过程

《Linux下进程的CPU配置与线程绑定过程》本文介绍Linux系统中基于进程和线程的CPU配置方法,通过taskset命令和pthread库调整亲和力,将进程/线程绑定到特定CPU核心以优化资源分配... 目录1 基于进程的CPU配置1.1 对CPU亲和力的配置1.2 绑定进程到指定CPU核上运行2 基于

Spring Boot spring-boot-maven-plugin 参数配置详解(最新推荐)

《SpringBootspring-boot-maven-plugin参数配置详解(最新推荐)》文章介绍了SpringBootMaven插件的5个核心目标(repackage、run、start... 目录一 spring-boot-maven-plugin 插件的5个Goals二 应用场景1 重新打包应用

Java中读取YAML文件配置信息常见问题及解决方法

《Java中读取YAML文件配置信息常见问题及解决方法》:本文主要介绍Java中读取YAML文件配置信息常见问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录1 使用Spring Boot的@ConfigurationProperties2. 使用@Valu

Jenkins分布式集群配置方式

《Jenkins分布式集群配置方式》:本文主要介绍Jenkins分布式集群配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1.安装jenkins2.配置集群总结Jenkins是一个开源项目,它提供了一个容易使用的持续集成系统,并且提供了大量的plugin满

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置(核心数、队列容量、拒绝策略等)及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略(Rejected

SQL Server配置管理器无法打开的四种解决方法

《SQLServer配置管理器无法打开的四种解决方法》本文总结了SQLServer配置管理器无法打开的四种解决方法,文中通过图文示例介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的... 目录方法一:桌面图标进入方法二:运行窗口进入检查版本号对照表php方法三:查找文件路径方法四:检查 S

MySQL查询JSON数组字段包含特定字符串的方法

《MySQL查询JSON数组字段包含特定字符串的方法》在MySQL数据库中,当某个字段存储的是JSON数组,需要查询数组中包含特定字符串的记录时传统的LIKE语句无法直接使用,下面小编就为大家介绍两种... 目录问题背景解决方案对比1. 精确匹配方案(推荐)2. 模糊匹配方案参数化查询示例使用场景建议性能优

Linux中SSH服务配置的全面指南

《Linux中SSH服务配置的全面指南》作为网络安全工程师,SSH(SecureShell)服务的安全配置是我们日常工作中不可忽视的重要环节,本文将从基础配置到高级安全加固,全面解析SSH服务的各项参... 目录概述基础配置详解端口与监听设置主机密钥配置认证机制强化禁用密码认证禁止root直接登录实现双因素