mikhail/parr_api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

структура

Browse Source
This commit is contained in:
Mikhail Kuznetsov
2023-05-17 16:00:50 +10:00
parent 7730559eca
commit 5338c489aa
18 changed files with 336 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
PARR.DAL/PARR.DAL.csproj Normal file
View File

@@ -0,0 +1,9 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
</Project>

42
PARR_API/Contracts/V1/ApiRoutes.cs Normal file
View File

@@ -0,0 +1,42 @@
namespace PARR_API.Contracts.V1
{
// https://tproger.ru/translations/luchshie-praktiki-razrabotki-rest-api-20-sovetov/
//----------URL должен отражать структуру вложенных ресурсов----------
// GET /shops/2/products получить список продуктов из магазина 2.
// GET /shops/2/products/31 получить детали продукта 31 из магазина 2.
// DELETE /shops/2/products/31 удалить продукт 31 из магазина 2.
// PUT /shops/2/products/31 обновить данные о продукте 31. Используйте PUT на URL ресурса, а не коллекции.
// POST /shops создать новый магазин и вернуть данные о нём.Используйте POST на URL коллекции.
//---------URL должен начинаться с коллекции и заканчиваться идентификатором---------
// GET /shops/:shopId/ или GET /category/:categoryId
public static class ApiRoutes
{
public const string Root = "api";
public const string Version = "v1";
public const string Base = Root + "/" + Version;
public static class ApiStatus
{
public const string Version = Base + "/version";
public const string Health = Base + "/health";
public const string Metrics = Base + "/metrics";
}
//public static class Layer
//{
// public const string GetAll = Base + "/layers/";
// public const string Get = Base + "/layers/" + getParam;
// public const string GetAreas = Base + "/layers/" + getParam + "/areas";
// public const string GetPlaces = Base + "/layers/" + getParam + "/places";
// public const string GetTemplates = Base + "/layers/" + getParam + "/templates";
// public const string getParam = "{id}";
//}
}
}

9
PARR_API/Controllers/V1/ApiStatusController.cs Normal file
View File

@@ -0,0 +1,9 @@
using PARR_API.Controllers.V1.Base;
namespace PARR_API.Controllers.V1
{
public class ApiStatusController : BaseApiController
{
//TODO:
}
}

10
PARR_API/Controllers/V1/Base/BaseApiController.cs Normal file
View File

@@ -0,0 +1,10 @@
using Microsoft.AspNetCore.Mvc;
namespace PARR_API.Controllers.V1.Base
{
[ApiController]
public class BaseApiController : ControllerBase
{
}
}

33
PARR_API/Controllers/WeatherForecastController.cs
View File

@@ -1,33 +0,0 @@
using Microsoft.AspNetCore.Mvc;
namespace PARR_API.Controllers
{
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
private static readonly string[] Summaries = new[]
{
"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
};
private readonly ILogger<WeatherForecastController> _logger;
public WeatherForecastController(ILogger<WeatherForecastController> logger)
{
_logger = logger;
}
[HttpGet(Name = "GetWeatherForecast")]
public IEnumerable<WeatherForecast> Get()
{
return Enumerable.Range(1, 5).Select(index => new WeatherForecast
{
Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
TemperatureC = Random.Shared.Next(-20, 55),
Summary = Summaries[Random.Shared.Next(Summaries.Length)]
})
.ToArray();
}
}
}

28
PARR_API/Installers/ApiServicesInstaller.cs Normal file
View File

@@ -0,0 +1,28 @@
using PARR_API.Services.Implementations;
using PARR_API.Services.Interfaces;
namespace PARR_API.Installers
{
/// <summary>
/// Самописные сервисы которые используются для АПИ
/// </summary>
public static class ApiServicesInstaller
{
public static void InstallApiServices(this IServiceCollection services, IConfiguration configuration)
{
services.AddSingleton<IUriService>(provider =>
{
var accessor = provider.GetRequiredService<IHttpContextAccessor>();
var request = accessor.HttpContext.Request;
var absoluteUri = string.Concat(request.Scheme, "://", request.Host.ToUriComponent(), "/");
return new UriService(absoluteUri);
});
//services.AddTransient<IFileService, FileService>();
}
}
}

25
PARR_API/Installers/CorsInstaller.cs Normal file
View File

@@ -0,0 +1,25 @@
using PARR_API.Settings;
namespace PARR_API.Installers
{
public static class CorsInstaller
{
public static void InstallCorsServices(this IServiceCollection services)
{
services.AddCors();
}
public static void InstallCors(this WebApplication app, WebApplicationBuilder builder)
{
var corsSettings = new CorsSettings();
builder.Configuration.GetSection(nameof(CorsSettings)).Bind(corsSettings);
app.UseCors(opt =>
opt.WithOrigins(corsSettings.AllowHostsArray)
.AllowAnyHeader()
.AllowAnyMethod()
);
}
}
}

17
PARR_API/Installers/SettingsInstaller.cs Normal file
View File

@@ -0,0 +1,17 @@
namespace PARR_API.Installers
{
/// <summary>
/// Биндинги из конфига appsettings
/// </summary>
public static class SettingsInstaller
{
public static void InstallSettings(this IServiceCollection services, IConfiguration configuration)
{
//var storageSettings = new StorageSettings();
//configuration.GetSection(nameof(StorageSettings)).Bind(storageSettings);
//services.AddSingleton(storageSettings);
//TODO: add other
}
}
}

47
PARR_API/Installers/SwaggerInstaller.cs Normal file
View File

@@ -0,0 +1,47 @@
using Microsoft.OpenApi.Models;
using System.Reflection;
namespace PARR_API.Installers
{
public static class SwaggerInstaller
{
public static void InstallSwaggerService(this IServiceCollection services, IConfiguration configuration)
{
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
services.AddEndpointsApiExplorer();
var version = Assembly.GetEntryAssembly()?.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion ?? "1.0.0";
services.AddSwaggerGen(x =>
{
//TODO:
x.SwaggerDoc(
"v1",
new OpenApiInfo
{
Title = "GEO API",
Version = $"v{version}",
Description = "API for the project \"GEO DVGD\"",
Contact = new OpenApiContact { Email = "IVC_TrubnikovME@dvgd.rzd;IVC_KuznetsovMV@dvgd.rzd", Name = "Trubnikov M.E., Kuznetsov M.V." },
License = new OpenApiLicense { Name = "© PTK-DVGD Software LLC" }
});
// Set the comments path for the Swagger JSON and UI.
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
x.IncludeXmlComments(xmlPath);
});
}
public static void InstallSwagger(this WebApplication app)
{
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI();
}
}
}
}

12
PARR_API/MappingProfiles/DomainToResponseProfile.cs Normal file
View File

@@ -0,0 +1,12 @@
using AutoMapper;
namespace PARR_API.MappingProfiles
{
public class DomainToResponseProfile : Profile
{
public DomainToResponseProfile()
{
// из проекта наружу
}
}
}

12
PARR_API/MappingProfiles/RequestToDomainProfile.cs Normal file
View File

@@ -0,0 +1,12 @@
using AutoMapper;
namespace PARR_API.MappingProfiles
{
public class RequestToDomainProfile : Profile
{
public RequestToDomainProfile()
{
// снаружи в проект
}
}
}

26
PARR_API/PARR_API.csproj
View File

@@ -4,11 +4,33 @@
<TargetFramework>net7.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<NoWarn>1701;1702;1591;1587;1573;NU1803</NoWarn>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<NoWarn>1701;1702;1591;1587;1573;NU1803</NoWarn>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="7.0.2" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="6.4.0" />
<PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="12.0.1" />
<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="11.5.2" />
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="7.0.5" />
<PackageReference Include="Serilog.AspNetCore" Version="7.0.0" />
<PackageReference Include="Serilog.Extensions.Hosting" Version="7.0.0" />
<PackageReference Include="Serilog.Sinks.Console" Version="4.1.0" />
<PackageReference Include="Serilog.Sinks.File" Version="5.0.0" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
</ItemGroup>
<ItemGroup>
<Folder Include="Contracts\V1\Requests\Queries\" />
<Folder Include="Contracts\V1\Responses\" />
<Folder Include="MappingProfiles\Resolvers\" />
<Folder Include="Validators\" />
</ItemGroup>
</Project>

28
PARR_API/Program.cs
View File

@@ -1,20 +1,36 @@
using FluentValidation;
using PARR_API.Installers;
using Serilog;
using System.Reflection;
var builder = WebApplication.CreateBuilder(args);
builder.Host.UseSerilog((context, config) =>
{
config
.WriteTo.Console()
.ReadFrom.Configuration(builder.Configuration);
});
// Add services to the container.
builder.Services.InstallApiServices(builder.Configuration);
builder.Services.InstallSettings(builder.Configuration);
builder.Services.AddAutoMapper(AppDomain.CurrentDomain.GetAssemblies());
builder.Services.AddHttpContextAccessor();
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddValidatorsFromAssembly(Assembly.GetExecutingAssembly());
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
builder.Services.InstallSwaggerService(builder.Configuration);
var app = builder.Build();
// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI();
}
app.InstallSwagger();
app.UseAuthorization();

35
PARR_API/Services/Implementations/UriService.cs Normal file
View File

@@ -0,0 +1,35 @@
using PARR_API.Services.Interfaces;
namespace PARR_API.Services.Implementations
{
public class UriService : IUriService
{
private readonly string baseUri;
public UriService(string baseUri)
{
this.baseUri = baseUri;
}
public Uri GetAllUri(string apiRoutesGetAll)
{
return new Uri(baseUri + apiRoutesGetAll);
}
public Uri GetUri(string apiRoutesGet, string apiRoutesGetParam, string value)
{
var modifiedUri = apiRoutesGet.Replace(apiRoutesGetParam, value);
return new Uri(baseUri + modifiedUri);
}
public Uri GetUri(string apiRoutesGet, string apiRoutesGetParam, Guid value)
{
return GetUri(apiRoutesGet, apiRoutesGetParam, value.ToString());
}
public Uri GetBaseUri()
{
return new Uri(baseUri);
}
}
}

10
PARR_API/Services/Interfaces/IUriService.cs Normal file
View File

@@ -0,0 +1,10 @@
namespace PARR_API.Services.Interfaces
{
public interface IUriService
{
Uri GetBaseUri();
Uri GetUri(string apiRoutesGet, string apiRoutesGetParam, string value);
Uri GetUri(string apiRoutesGet, string apiRoutesGetParam, Guid value);
Uri GetAllUri(string apiRoutesGetAll);
}
}

9
PARR_API/Settings/CorsSettings.cs Normal file
View File

@@ -0,0 +1,9 @@
namespace PARR_API.Settings
{
public class CorsSettings
{
public string AllowedHosts { get; set; } = string.Empty;
public string[] AllowHostsArray => AllowedHosts.Split(';').Select(t => t.Trim()).ToArray();
}
}

13
PARR_API/WeatherForecast.cs
View File

@@ -1,13 +0,0 @@
namespace PARR_API
{
public class WeatherForecast
{
public DateOnly Date { get; set; }
public int TemperatureC { get; set; }
public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
public string? Summary { get; set; }
}
}

24
PARR_API/appsettings.json
View File

@@ -1,9 +1,33 @@
{
"ConnectionStrings": {
"DefaultConnection": "Server=10.99.253.184;Database=geo;User Id=app_geo; Password=Khdlifg(G875904HJFfd@3;"
},
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
},
"Serilog": {
"MinimumLevel": {
"Default": "Information",
"Override": {
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"WriteTo": [
{
"Name": "File",
"Args": {
"path": "log/log-.txt",
"rollingInterval": "Day"
}
}
]
},
"AllowedHosts": "*",
"CorsSettings": {
"AllowedHosts": "*"
}
}