feat: add Configuration gRPC service and queries for club settings and features

This commit is contained in:
masoodafar-web
2025-12-19 00:30:58 +03:30
parent 9db854ba0e
commit 0cca79ebfe
17 changed files with 765 additions and 19 deletions
@@ -0,0 +1,6 @@
namespace FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubConfiguration;
/// <summary>
/// دریافت تنظیمات باشگاه مشتریان
/// </summary>
public record GetClubConfigurationQuery : IRequest<GetClubConfigurationResponseDto>;
@@ -0,0 +1,43 @@
using CMSMicroservice.Protobuf.Protos.Configuration;
namespace FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubConfiguration;
/// <summary>
/// هندلر دریافت تنظیمات باشگاه مشتریان از CMS
/// </summary>
public class GetClubConfigurationQueryHandler : IRequestHandler<GetClubConfigurationQuery, GetClubConfigurationResponseDto>
{
private readonly IApplicationContractContext _context;
public GetClubConfigurationQueryHandler(IApplicationContractContext context)
{
_context = context;
}
public async Task<GetClubConfigurationResponseDto> Handle(GetClubConfigurationQuery request, CancellationToken cancellationToken)
{
// دریافت مبلغ فعال‌سازی از CMS
var activationFeeRequest = new GetConfigurationByKeyRequest
{
Scope = 2, // ConfigurationScope.Club
Key = "Club.ActivationFee"
};
var giftValueRequest = new GetConfigurationByKeyRequest
{
Scope = 2, // ConfigurationScope.Club
Key = "Club.MembershipGiftValue"
};
var activationFeeResponse = await _context.Configuration.GetConfigurationByKeyAsync(activationFeeRequest, cancellationToken: cancellationToken);
var giftValueResponse = await _context.Configuration.GetConfigurationByKeyAsync(giftValueRequest, cancellationToken: cancellationToken);
var response = new GetClubConfigurationResponseDto
{
ActivationFee = long.TryParse(activationFeeResponse?.Value, out var fee) ? fee : 25000000,
MembershipGiftValue = long.TryParse(giftValueResponse?.Value, out var gift) ? gift : 25200000
};
return response;
}
}
@@ -0,0 +1,17 @@
namespace FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubConfiguration;
/// <summary>
/// پاسخ تنظیمات باشگاه مشتریان
/// </summary>
public class GetClubConfigurationResponseDto
{
/// <summary>
/// هزینه فعال‌سازی عضویت باشگاه (ریال)
/// </summary>
public long ActivationFee { get; set; }
/// <summary>
/// مبلغ هدیه حق عضویت باشگاه (ریال)
/// </summary>
public long MembershipGiftValue { get; set; }
}
@@ -0,0 +1,6 @@
namespace FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubFeatures;
/// <summary>
/// دریافت لیست فیچرهای باشگاه مشتریان برای کاربر جاری
/// </summary>
public record GetClubFeaturesQuery : IRequest<GetClubFeaturesResponseDto>;
@@ -0,0 +1,53 @@
using CMSMicroservice.Protobuf.Protos.ClubMembership;
using FrontOffice.BFF.Application.Common.Interfaces;
namespace FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubFeatures;
/// <summary>
/// هندلر دریافت فیچرهای باشگاه مشتریان برای کاربر جاری
/// </summary>
public class GetClubFeaturesQueryHandler : IRequestHandler<GetClubFeaturesQuery, GetClubFeaturesResponseDto>
{
private readonly IApplicationContractContext _context;
private readonly ICurrentUserService _currentUser;
public GetClubFeaturesQueryHandler(
IApplicationContractContext context,
ICurrentUserService currentUser)
{
_context = context;
_currentUser = currentUser;
}
public async Task<GetClubFeaturesResponseDto> Handle(GetClubFeaturesQuery request, CancellationToken cancellationToken)
{
// دریافت فیچرهای باشگاه برای کاربر جاری
var getUserFeaturesRequest = new GetUserClubFeaturesRequest
{
UserId = _currentUser.UserId ?? 0
};
var response = await _context.ClubMemberships.GetUserClubFeaturesAsync(
getUserFeaturesRequest,
cancellationToken: cancellationToken);
var result = new GetClubFeaturesResponseDto
{
Features = response.Features.Select(f => new ClubFeatureItemDto
{
Id = f.ClubFeatureId,
Title = f.FeatureTitle ?? string.Empty,
Description = f.FeatureDescription,
IsEnabled = f.IsActive,
DisplayOrder = f.SortOrder,
GrantedAt = f.GrantedAt?.ToDateTime() ?? DateTime.MinValue,
CreatedAt = f.CreatedAt?.ToDateTime() ?? DateTime.MinValue,
Notes = f.Notes
})
.OrderBy(f => f.DisplayOrder)
.ToList()
};
return result;
}
}
@@ -0,0 +1,18 @@
namespace FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubFeatures;
public class GetClubFeaturesResponseDto
{
public List<ClubFeatureItemDto> Features { get; set; } = new();
}
public class ClubFeatureItemDto
{
public long Id { get; set; }
public string Title { get; set; } = string.Empty;
public string? Description { get; set; }
public bool IsEnabled { get; set; }
public int DisplayOrder { get; set; }
public DateTime GrantedAt { get; set; }
public DateTime CreatedAt { get; set; }
public string? Notes { get; set; }
}
@@ -26,29 +26,36 @@ public class GetVATRateQueryHandler : IRequestHandler<GetVATRateQuery, GetVATRat
try try
{ {
// دریافت نرخ مالیات از تنظیمات سیستم // دریافت تنظیمات VAT از CMS
// Scope: VAT = 4 // Scope: VAT = 4
var rateConfig = await _context.Configuration.GetConfigurationByKeyAsync( var allConfigs = await _context.Configuration.GetAllConfigurationsAsync(
new GetConfigurationByKeyRequest { Key = "VAT.Rate" }, new GetAllConfigurationsRequest
{
Filter = new GetAllConfigurationsFilter
{
Scope = 4, // VAT scope
IsActive = true
}
},
cancellationToken: cancellationToken); cancellationToken: cancellationToken);
if (rateConfig != null && !string.IsNullOrEmpty(rateConfig.Value)) if (allConfigs?.Models != null)
{ {
if (double.TryParse(rateConfig.Value, out var rate)) foreach (var config in allConfigs.Models)
{
if (config.Key == "Shop.VAT" && !string.IsNullOrEmpty(config.Value))
{
if (double.TryParse(config.Value, out var rate))
{ {
response.VatRate = rate; response.VatRate = rate;
response.VatPercentage = (int)(rate * 100); response.VatPercentage = (int)(rate * 100);
} }
} }
else if (config.Key == "IsEnabled" && !string.IsNullOrEmpty(config.Value))
// دریافت وضعیت فعال بودن مالیات
var enabledConfig = await _context.Configuration.GetConfigurationByKeyAsync(
new GetConfigurationByKeyRequest { Key = "VAT.IsEnabled" },
cancellationToken: cancellationToken);
if (enabledConfig != null && !string.IsNullOrEmpty(enabledConfig.Value))
{ {
response.IsEnabled = bool.TryParse(enabledConfig.Value, out var enabled) && enabled; response.IsEnabled = bool.TryParse(config.Value, out var enabled) && enabled;
}
}
} }
} }
catch catch
@@ -0,0 +1,38 @@
using FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubConfiguration;
using FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubFeatures;
using Google.Protobuf.WellKnownTypes;
using ProtoDto = FrontOffice.BFF.Configuration.Protobuf.Protos.Configuration;
namespace FrontOffice.BFF.WebApi.Common.Mappings;
public class ConfigurationProfile : IRegister
{
void IRegister.Register(TypeAdapterConfig config)
{
// GetClubConfiguration mappings
config.NewConfig<GetClubConfigurationResponseDto, ProtoDto.GetClubConfigurationResponse>()
.Map(dest => dest.ActivationFee, src => src.ActivationFee)
.Map(dest => dest.MembershipGiftValue, src => src.MembershipGiftValue);
// GetClubFeatures mappings
config.NewConfig<GetClubFeaturesResponseDto, ProtoDto.GetClubFeaturesResponse>()
.MapWith(src => new ProtoDto.GetClubFeaturesResponse
{
Features = { src.Features.Select(f => f.Adapt<ProtoDto.ClubFeatureModel>()) }
});
config.NewConfig<ClubFeatureItemDto, ProtoDto.ClubFeatureModel>()
.Map(dest => dest.Id, src => src.Id)
.Map(dest => dest.Title, src => src.Title)
.Map(dest => dest.Description, src => src.Description ?? "")
.Map(dest => dest.IsEnabled, src => src.IsEnabled)
.Map(dest => dest.DisplayOrder, src => src.DisplayOrder)
.Map(dest => dest.GrantedAt, src => src.GrantedAt != DateTime.MinValue
? Timestamp.FromDateTime(DateTime.SpecifyKind(src.GrantedAt, DateTimeKind.Utc))
: null)
.Map(dest => dest.CreatedAt, src => src.CreatedAt != DateTime.MinValue
? Timestamp.FromDateTime(DateTime.SpecifyKind(src.CreatedAt, DateTimeKind.Utc))
: null)
.Map(dest => dest.Notes, src => src.Notes ?? "");
}
}
@@ -36,6 +36,7 @@
<ProjectReference Include="..\Protobufs\FrontOffice.BFF.DiscountShop.Protobuf\FrontOffice.BFF.DiscountShop.Protobuf.csproj" /> <ProjectReference Include="..\Protobufs\FrontOffice.BFF.DiscountShop.Protobuf\FrontOffice.BFF.DiscountShop.Protobuf.csproj" />
<ProjectReference Include="..\Protobufs\FrontOffice.BFF.Commission.Protobuf\FrontOffice.BFF.Commission.Protobuf.csproj" /> <ProjectReference Include="..\Protobufs\FrontOffice.BFF.Commission.Protobuf\FrontOffice.BFF.Commission.Protobuf.csproj" />
<ProjectReference Include="..\Protobufs\FrontOffice.BFF.ClubMembership.Protobuf\FrontOffice.BFF.ClubMembership.Protobuf.csproj" /> <ProjectReference Include="..\Protobufs\FrontOffice.BFF.ClubMembership.Protobuf\FrontOffice.BFF.ClubMembership.Protobuf.csproj" />
<ProjectReference Include="..\Protobufs\FrontOffice.BFF.Configuration.Protobuf\FrontOffice.BFF.Configuration.Protobuf.csproj" />
<ProjectReference Include="..\Protobufs\FrontOffice.BFF.NetworkMembership.Protobuf\FrontOffice.BFF.NetworkMembership.Protobuf.csproj" /> <ProjectReference Include="..\Protobufs\FrontOffice.BFF.NetworkMembership.Protobuf\FrontOffice.BFF.NetworkMembership.Protobuf.csproj" />
<ProjectReference Include="..\Protobufs\FrontOffice.BFF.City.Protobuf\FrontOffice.BFF.City.Protobuf.csproj" /> <ProjectReference Include="..\Protobufs\FrontOffice.BFF.City.Protobuf\FrontOffice.BFF.City.Protobuf.csproj" />
</ItemGroup> </ItemGroup>
@@ -0,0 +1,35 @@
using FrontOffice.BFF.WebApi.Common.Services;
using FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubConfiguration;
using FrontOffice.BFF.Application.ConfigurationCQ.Queries.GetClubFeatures;
using FrontOffice.BFF.Configuration.Protobuf.Protos.Configuration;
namespace FrontOffice.BFF.WebApi.Services;
/// <summary>
/// سرویس تنظیمات - برای کاربران FrontOffice
/// </summary>
public class ConfigurationGrpcService : ConfigurationContract.ConfigurationContractBase
{
private readonly IDispatchRequestToCQRS _dispatchRequestToCQRS;
public ConfigurationGrpcService(IDispatchRequestToCQRS dispatchRequestToCQRS)
{
_dispatchRequestToCQRS = dispatchRequestToCQRS;
}
/// <summary>
/// دریافت تنظیمات باشگاه مشتریان
/// </summary>
public override async Task<GetClubConfigurationResponse> GetClubConfiguration(Empty request, ServerCallContext context)
{
return await _dispatchRequestToCQRS.Handle<GetClubConfigurationQuery, GetClubConfigurationResponse>(context);
}
/// <summary>
/// دریافت لیست فیچرهای باشگاه مشتریان
/// </summary>
public override async Task<GetClubFeaturesResponse> GetClubFeatures(Empty request, ServerCallContext context)
{
return await _dispatchRequestToCQRS.Handle<GetClubFeaturesQuery, GetClubFeaturesResponse>(context);
}
}
@@ -7,15 +7,19 @@ using FrontOffice.BFF.Application.UserOrderCQ.Queries.GetAllUserOrderByFilter;
using FrontOffice.BFF.Application.UserOrderCQ.Queries.GetVATRate; using FrontOffice.BFF.Application.UserOrderCQ.Queries.GetVATRate;
using FrontOffice.BFF.Application.UserOrderCQ.Commands.SubmitShopBuyOrder; using FrontOffice.BFF.Application.UserOrderCQ.Commands.SubmitShopBuyOrder;
using FrontOffice.BFF.UserOrder.Protobuf.Protos.UserOrder; using FrontOffice.BFF.UserOrder.Protobuf.Protos.UserOrder;
using MediatR;
using Mapster;
namespace FrontOffice.BFF.WebApi.Services; namespace FrontOffice.BFF.WebApi.Services;
public class UserOrderService : UserOrderContract.UserOrderContractBase public class UserOrderService : UserOrderContract.UserOrderContractBase
{ {
private readonly IDispatchRequestToCQRS _dispatchRequestToCQRS; private readonly IDispatchRequestToCQRS _dispatchRequestToCQRS;
private readonly ISender _mediator;
public UserOrderService(IDispatchRequestToCQRS dispatchRequestToCQRS) public UserOrderService(IDispatchRequestToCQRS dispatchRequestToCQRS, ISender mediator)
{ {
_dispatchRequestToCQRS = dispatchRequestToCQRS; _dispatchRequestToCQRS = dispatchRequestToCQRS;
_mediator = mediator;
} }
public override async Task<CreateNewUserOrderResponse> CreateNewUserOrder(CreateNewUserOrderRequest request, ServerCallContext context) public override async Task<CreateNewUserOrderResponse> CreateNewUserOrder(CreateNewUserOrderRequest request, ServerCallContext context)
{ {
@@ -44,6 +48,7 @@ public class UserOrderService : UserOrderContract.UserOrderContractBase
public override async Task<GetVATRateResponse> GetVATRate(Empty request, ServerCallContext context) public override async Task<GetVATRateResponse> GetVATRate(Empty request, ServerCallContext context)
{ {
return await _dispatchRequestToCQRS.Handle<Empty, GetVATRateQuery, GetVATRateResponse>(request, context); var result = await _mediator.Send(new GetVATRateQuery());
return result.Adapt<GetVATRateResponse>();
} }
} }
+15
View File
@@ -41,6 +41,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FrontOffice.BFF.NetworkMemb
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FrontOffice.BFF.City.Protobuf", "Protobufs\FrontOffice.BFF.City.Protobuf\FrontOffice.BFF.City.Protobuf.csproj", "{41403EBB-E67B-413B-8B7A-64D67E221984}" Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FrontOffice.BFF.City.Protobuf", "Protobufs\FrontOffice.BFF.City.Protobuf\FrontOffice.BFF.City.Protobuf.csproj", "{41403EBB-E67B-413B-8B7A-64D67E221984}"
EndProject EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FrontOffice.BFF.Configuration.Protobuf", "Protobufs\FrontOffice.BFF.Configuration.Protobuf\FrontOffice.BFF.Configuration.Protobuf.csproj", "{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}"
EndProject
Global Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU Debug|Any CPU = Debug|Any CPU
@@ -267,6 +269,18 @@ Global
{41403EBB-E67B-413B-8B7A-64D67E221984}.Release|x64.Build.0 = Release|Any CPU {41403EBB-E67B-413B-8B7A-64D67E221984}.Release|x64.Build.0 = Release|Any CPU
{41403EBB-E67B-413B-8B7A-64D67E221984}.Release|x86.ActiveCfg = Release|Any CPU {41403EBB-E67B-413B-8B7A-64D67E221984}.Release|x86.ActiveCfg = Release|Any CPU
{41403EBB-E67B-413B-8B7A-64D67E221984}.Release|x86.Build.0 = Release|Any CPU {41403EBB-E67B-413B-8B7A-64D67E221984}.Release|x86.Build.0 = Release|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Debug|Any CPU.Build.0 = Debug|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Debug|x64.ActiveCfg = Debug|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Debug|x64.Build.0 = Debug|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Debug|x86.ActiveCfg = Debug|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Debug|x86.Build.0 = Debug|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Release|Any CPU.ActiveCfg = Release|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Release|Any CPU.Build.0 = Release|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Release|x64.ActiveCfg = Release|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Release|x64.Build.0 = Release|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Release|x86.ActiveCfg = Release|Any CPU
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection EndGlobalSection
GlobalSection(SolutionProperties) = preSolution GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE HideSolutionNode = FALSE
@@ -286,5 +300,6 @@ Global
{B6EAE0A3-3427-4D86-B2BA-B185F476B74F} = {CA9BF4D6-6729-4011-888E-48F5F739B469} {B6EAE0A3-3427-4D86-B2BA-B185F476B74F} = {CA9BF4D6-6729-4011-888E-48F5F739B469}
{CCA23A57-4BC4-4C53-9A96-41FCFF5407F5} = {CA9BF4D6-6729-4011-888E-48F5F739B469} {CCA23A57-4BC4-4C53-9A96-41FCFF5407F5} = {CA9BF4D6-6729-4011-888E-48F5F739B469}
{41403EBB-E67B-413B-8B7A-64D67E221984} = {CA9BF4D6-6729-4011-888E-48F5F739B469} {41403EBB-E67B-413B-8B7A-64D67E221984} = {CA9BF4D6-6729-4011-888E-48F5F739B469}
{4FFEE929-9DFF-4C60-A22C-A75DD44D2A01} = {CA9BF4D6-6729-4011-888E-48F5F739B469}
EndGlobalSection EndGlobalSection
EndGlobal EndGlobal
@@ -0,0 +1,13 @@
using FluentValidation;
using System.Reflection;
namespace Microsoft.Extensions.DependencyInjection;
public static class ConfigureServices
{
public static IServiceCollection AddConfigurationProtobufServices(this IServiceCollection services)
{
services.AddValidatorsFromAssembly(Assembly.GetExecutingAssembly());
return services;
}
}
@@ -0,0 +1,29 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<Version>0.0.1</Version>
<DebugType>None</DebugType>
<DebugSymbols>False</DebugSymbols>
<GeneratePackageOnBuild>False</GeneratePackageOnBuild>
<PackageId>Foursat.FrontOffice.BFF.Configuration.Protobuf</PackageId>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Google.Protobuf" Version="3.33.0" />
<PackageReference Include="Grpc.Core.Api" Version="2.71.0" />
<PackageReference Include="Grpc.Tools" Version="2.76.0">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="12.1.0" />
<PackageReference Include="Google.Api.CommonProtos" Version="2.17.0" />
</ItemGroup>
<ItemGroup>
<Protobuf Include="Protos\configuration.proto" ProtoRoot="Protos\" GrpcServices="Both" />
</ItemGroup>
</Project>
@@ -0,0 +1,52 @@
syntax = "proto3";
package configuration;
import "google/protobuf/empty.proto";
import "google/protobuf/wrappers.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "FrontOffice.BFF.Configuration.Protobuf.Protos.Configuration";
service ConfigurationContract
{
// دریافت تنظیمات باشگاه مشتریان
rpc GetClubConfiguration(google.protobuf.Empty) returns (GetClubConfigurationResponse){
option (google.api.http) = {
get: "/Configuration/Club"
};
};
// دریافت لیست فیچرهای باشگاه مشتریان
rpc GetClubFeatures(google.protobuf.Empty) returns (GetClubFeaturesResponse){
option (google.api.http) = {
get: "/Configuration/ClubFeatures"
};
};
}
// پاسخ تنظیمات باشگاه
message GetClubConfigurationResponse
{
int64 activation_fee = 1; // هزینه فعال‌سازی (ریال)
int64 membership_gift_value = 2; // مبلغ هدیه عضویت (ریال)
}
// پاسخ فیچرهای باشگاه
message GetClubFeaturesResponse
{
repeated ClubFeatureModel features = 1;
}
message ClubFeatureModel
{
int64 id = 1;
string title = 2;
string description = 3;
bool is_enabled = 4; // آیا فعال است (از UserClubFeature)
int32 display_order = 5; // ترتیب نمایش
google.protobuf.Timestamp granted_at = 6; // تاریخ فعال‌سازی
google.protobuf.Timestamp created_at = 7; // تاریخ ایجاد
string notes = 8; // یادداشت (برای نمایش در مدال جزئیات)
}
@@ -0,0 +1,31 @@
// Copyright (c) 2015, Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.api;
import "google/api/http.proto";
import "google/protobuf/descriptor.proto";
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
option java_multiple_files = true;
option java_outer_classname = "AnnotationsProto";
option java_package = "com.google.api";
option objc_class_prefix = "GAPI";
extend google.protobuf.MethodOptions {
// See `HttpRule`.
HttpRule http = 72295728;
}
@@ -0,0 +1,377 @@
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
syntax = "proto3";
package google.api;
option cc_enable_arenas = true;
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
option java_multiple_files = true;
option java_outer_classname = "HttpProto";
option java_package = "com.google.api";
option objc_class_prefix = "GAPI";
// Defines the HTTP configuration for an API service. It contains a list of
// [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
// to one or more HTTP REST API methods.
message Http {
// A list of HTTP configuration rules that apply to individual API methods.
//
// **NOTE:** All service configuration rules follow "last one wins" order.
repeated HttpRule rules = 1;
// When set to true, URL path parameters will be fully URI-decoded except in
// cases of single segment matches in reserved expansion, where "%2F" will be
// left encoded.
//
// The default behavior is to not decode RFC 6570 reserved characters in multi
// segment matches.
bool fully_decode_reserved_expansion = 2;
}
// # gRPC Transcoding
//
// gRPC Transcoding is a feature for mapping between a gRPC method and one or
// more HTTP REST endpoints. It allows developers to build a single API service
// that supports both gRPC APIs and REST APIs. Many systems, including [Google
// APIs](https://github.com/googleapis/googleapis),
// [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
// Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
// and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
// and use it for large scale production services.
//
// `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
// how different portions of the gRPC request message are mapped to the URL
// path, URL query parameters, and HTTP request body. It also controls how the
// gRPC response message is mapped to the HTTP response body. `HttpRule` is
// typically specified as an `google.api.http` annotation on the gRPC method.
//
// Each mapping specifies a URL path template and an HTTP method. The path
// template may refer to one or more fields in the gRPC request message, as long
// as each field is a non-repeated field with a primitive (non-message) type.
// The path template controls how fields of the request message are mapped to
// the URL path.
//
// Example:
//
// service Messaging {
// rpc GetMessage(GetMessageRequest) returns (Message) {
// option (google.api.http) = {
// get: "/v1/{name=messages/*}"
// };
// }
// }
// message GetMessageRequest {
// string name = 1; // Mapped to URL path.
// }
// message Message {
// string text = 1; // The resource content.
// }
//
// This enables an HTTP REST to gRPC mapping as below:
//
// HTTP | gRPC
// -----|-----
// `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
//
// Any fields in the request message which are not bound by the path template
// automatically become HTTP query parameters if there is no HTTP request body.
// For example:
//
// service Messaging {
// rpc GetMessage(GetMessageRequest) returns (Message) {
// option (google.api.http) = {
// get:"/v1/messages/{message_id}"
// };
// }
// }
// message GetMessageRequest {
// message SubMessage {
// string subfield = 1;
// }
// string message_id = 1; // Mapped to URL path.
// int64 revision = 2; // Mapped to URL query parameter `revision`.
// SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
// }
//
// This enables a HTTP JSON to RPC mapping as below:
//
// HTTP | gRPC
// -----|-----
// `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
// `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
// "foo"))`
//
// Note that fields which are mapped to URL query parameters must have a
// primitive type or a repeated primitive type or a non-repeated message type.
// In the case of a repeated type, the parameter can be repeated in the URL
// as `...?param=A&param=B`. In the case of a message type, each field of the
// message is mapped to a separate parameter, such as
// `...?foo.a=A&foo.b=B&foo.c=C`.
//
// For HTTP methods that allow a request body, the `body` field
// specifies the mapping. Consider a REST update method on the
// message resource collection:
//
// service Messaging {
// rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
// option (google.api.http) = {
// patch: "/v1/messages/{message_id}"
// body: "message"
// };
// }
// }
// message UpdateMessageRequest {
// string message_id = 1; // mapped to the URL
// Message message = 2; // mapped to the body
// }
//
// The following HTTP JSON to RPC mapping is enabled, where the
// representation of the JSON in the request body is determined by
// protos JSON encoding:
//
// HTTP | gRPC
// -----|-----
// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
// "123456" message { text: "Hi!" })`
//
// The special name `*` can be used in the body mapping to define that
// every field not bound by the path template should be mapped to the
// request body. This enables the following alternative definition of
// the update method:
//
// service Messaging {
// rpc UpdateMessage(Message) returns (Message) {
// option (google.api.http) = {
// patch: "/v1/messages/{message_id}"
// body: "*"
// };
// }
// }
// message Message {
// string message_id = 1;
// string text = 2;
// }
//
//
// The following HTTP JSON to RPC mapping is enabled:
//
// HTTP | gRPC
// -----|-----
// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
// "123456" text: "Hi!")`
//
// Note that when using `*` in the body mapping, it is not possible to
// have HTTP parameters, as all fields not bound by the path end in
// the body. This makes this option more rarely used in practice when
// defining REST APIs. The common usage of `*` is in custom methods
// which don't use the URL at all for transferring data.
//
// It is possible to define multiple HTTP methods for one RPC by using
// the `additional_bindings` option. Example:
//
// service Messaging {
// rpc GetMessage(GetMessageRequest) returns (Message) {
// option (google.api.http) = {
// get: "/v1/messages/{message_id}"
// additional_bindings {
// get: "/v1/users/{user_id}/messages/{message_id}"
// }
// };
// }
// }
// message GetMessageRequest {
// string message_id = 1;
// string user_id = 2;
// }
//
// This enables the following two alternative HTTP JSON to RPC mappings:
//
// HTTP | gRPC
// -----|-----
// `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
// `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
// "123456")`
//
// ## Rules for HTTP mapping
//
// 1. Leaf request fields (recursive expansion nested messages in the request
// message) are classified into three categories:
// - Fields referred by the path template. They are passed via the URL path.
// - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP
// request body.
// - All other fields are passed via the URL query parameters, and the
// parameter name is the field path in the request message. A repeated
// field can be represented as multiple query parameters under the same
// name.
// 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields
// are passed via URL path and HTTP request body.
// 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all
// fields are passed via URL path and URL query parameters.
//
// ### Path template syntax
//
// Template = "/" Segments [ Verb ] ;
// Segments = Segment { "/" Segment } ;
// Segment = "*" | "**" | LITERAL | Variable ;
// Variable = "{" FieldPath [ "=" Segments ] "}" ;
// FieldPath = IDENT { "." IDENT } ;
// Verb = ":" LITERAL ;
//
// The syntax `*` matches a single URL path segment. The syntax `**` matches
// zero or more URL path segments, which must be the last part of the URL path
// except the `Verb`.
//
// The syntax `Variable` matches part of the URL path as specified by its
// template. A variable template must not contain other variables. If a variable
// matches a single path segment, its template may be omitted, e.g. `{var}`
// is equivalent to `{var=*}`.
//
// The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
// contains any reserved character, such characters should be percent-encoded
// before the matching.
//
// If a variable contains exactly one path segment, such as `"{var}"` or
// `"{var=*}"`, when such a variable is expanded into a URL path on the client
// side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
// server side does the reverse decoding. Such variables show up in the
// [Discovery
// Document](https://developers.google.com/discovery/v1/reference/apis) as
// `{var}`.
//
// If a variable contains multiple path segments, such as `"{var=foo/*}"`
// or `"{var=**}"`, when such a variable is expanded into a URL path on the
// client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
// The server side does the reverse decoding, except "%2F" and "%2f" are left
// unchanged. Such variables show up in the
// [Discovery
// Document](https://developers.google.com/discovery/v1/reference/apis) as
// `{+var}`.
//
// ## Using gRPC API Service Configuration
//
// gRPC API Service Configuration (service config) is a configuration language
// for configuring a gRPC service to become a user-facing product. The
// service config is simply the YAML representation of the `google.api.Service`
// proto message.
//
// As an alternative to annotating your proto file, you can configure gRPC
// transcoding in your service config YAML files. You do this by specifying a
// `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
// effect as the proto annotation. This can be particularly useful if you
// have a proto that is reused in multiple services. Note that any transcoding
// specified in the service config will override any matching transcoding
// configuration in the proto.
//
// Example:
//
// http:
// rules:
// # Selects a gRPC method and applies HttpRule to it.
// - selector: example.v1.Messaging.GetMessage
// get: /v1/messages/{message_id}/{sub.subfield}
//
// ## Special notes
//
// When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
// proto to JSON conversion must follow the [proto3
// specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
//
// While the single segment variable follows the semantics of
// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
// Expansion, the multi segment variable **does not** follow RFC 6570 Section
// 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
// does not expand special characters like `?` and `#`, which would lead
// to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
// for multi segment variables.
//
// The path variables **must not** refer to any repeated or mapped field,
// because client libraries are not capable of handling such variable expansion.
//
// The path variables **must not** capture the leading "/" character. The reason
// is that the most common use case "{var}" does not capture the leading "/"
// character. For consistency, all path variables must share the same behavior.
//
// Repeated message fields must not be mapped to URL query parameters, because
// no client library can support such complicated mapping.
//
// If an API needs to use a JSON array for request or response body, it can map
// the request or response body to a repeated field. However, some gRPC
// Transcoding implementations may not support this feature.
message HttpRule {
// Selects a method to which this rule applies.
//
// Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;
// Determines the URL pattern is matched by this rules. This pattern can be
// used with any of the {get|put|post|delete|patch} methods. A custom method
// can be defined using the 'custom' field.
oneof pattern {
// Maps to HTTP GET. Used for listing and getting information about
// resources.
string get = 2;
// Maps to HTTP PUT. Used for replacing a resource.
string put = 3;
// Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 4;
// Maps to HTTP DELETE. Used for deleting a resource.
string delete = 5;
// Maps to HTTP PATCH. Used for updating a resource.
string patch = 6;
// The custom pattern is used for specifying an HTTP method that is not
// included in the `pattern` field, such as HEAD, or "*" to leave the
// HTTP method unspecified for this rule. The wild-card rule is useful
// for services that provide content to Web (HTML) clients.
CustomHttpPattern custom = 8;
}
// The name of the request field whose value is mapped to the HTTP request
// body, or `*` for mapping all request fields not captured by the path
// pattern to the HTTP body, or omitted for not having any HTTP request body.
//
// NOTE: the referred field must be present at the top-level of the request
// message type.
string body = 7;
// Optional. The name of the response field whose value is mapped to the HTTP
// response body. When omitted, the entire response message will be used
// as the HTTP response body.
//
// NOTE: The referred field must be present at the top-level of the response
// message type.
string response_body = 12;
// Additional HTTP bindings for the selector. Nested bindings must
// not contain an `additional_bindings` field themselves (that is,
// the nesting may only be one level deep).
repeated HttpRule additional_bindings = 11;
}
// A custom pattern is used for defining custom HTTP verb.
message CustomHttpPattern {
// The name of this custom HTTP verb.
string kind = 1;
// The path matched by this custom verb.
string path = 2;
}