Исправления сваггер
This commit is contained in:
@@ -6,24 +6,101 @@ namespace Nashel.Modules.Catalog.Application.Common;
|
||||
/// <summary>
|
||||
/// DTO категории.
|
||||
/// </summary>
|
||||
public record CategoryDto(
|
||||
Guid Id,
|
||||
string Title,
|
||||
string Slug,
|
||||
Guid? ParentId,
|
||||
JsonDocument? AttributeSchema
|
||||
);
|
||||
public record CategoryDto
|
||||
{
|
||||
/// <summary>
|
||||
/// Уникальный идентификатор категории.
|
||||
/// </summary>
|
||||
public Guid Id { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Название категории.
|
||||
/// </summary>
|
||||
public string Title { get; init; } = default!;
|
||||
|
||||
/// <summary>
|
||||
/// URL-совместимый идентификатор (slug).
|
||||
/// </summary>
|
||||
public string Slug { get; init; } = default!;
|
||||
|
||||
/// <summary>
|
||||
/// Идентификатор родительской категории (null, если корневая).
|
||||
/// </summary>
|
||||
public Guid? ParentId { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// JSON-схема характеристик, специфичных для категории.
|
||||
/// </summary>
|
||||
public JsonDocument? AttributeSchema { get; init; }
|
||||
|
||||
public CategoryDto(Guid id, string title, string slug, Guid? parentId, JsonDocument? attributeSchema)
|
||||
{
|
||||
Id = id;
|
||||
Title = title;
|
||||
Slug = slug;
|
||||
ParentId = parentId;
|
||||
AttributeSchema = attributeSchema;
|
||||
}
|
||||
|
||||
public CategoryDto() { }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// DTO услуги/оффера.
|
||||
/// </summary>
|
||||
public record OfferDto(
|
||||
Guid Id,
|
||||
Guid OwnerId,
|
||||
Guid CategoryId,
|
||||
string Title,
|
||||
string Description,
|
||||
Price Price,
|
||||
JsonDocument? Attributes,
|
||||
bool IsActive
|
||||
);
|
||||
public record OfferDto
|
||||
{
|
||||
/// <summary>
|
||||
/// Уникальный идентификатор услуги.
|
||||
/// </summary>
|
||||
public Guid Id { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Идентификатор владельца (исполнителя).
|
||||
/// </summary>
|
||||
public Guid OwnerId { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Идентификатор категории.
|
||||
/// </summary>
|
||||
public Guid CategoryId { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Заголовок услуги.
|
||||
/// </summary>
|
||||
public string Title { get; init; } = default!;
|
||||
|
||||
/// <summary>
|
||||
/// Подробное описание услуги.
|
||||
/// </summary>
|
||||
public string Description { get; init; } = default!;
|
||||
|
||||
/// <summary>
|
||||
/// Цена услуги.
|
||||
/// </summary>
|
||||
public Price Price { get; init; } = default!;
|
||||
|
||||
/// <summary>
|
||||
/// JSON-объект с характеристиками услуги.
|
||||
/// </summary>
|
||||
public JsonDocument? Attributes { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Флаг активности услуги.
|
||||
/// </summary>
|
||||
public bool IsActive { get; init; }
|
||||
|
||||
public OfferDto(Guid id, Guid ownerId, Guid categoryId, string title, string description, Price price, JsonDocument? attributes, bool isActive)
|
||||
{
|
||||
Id = id;
|
||||
OwnerId = ownerId;
|
||||
CategoryId = categoryId;
|
||||
Title = title;
|
||||
Description = description;
|
||||
Price = price;
|
||||
Attributes = attributes;
|
||||
IsActive = isActive;
|
||||
}
|
||||
|
||||
public OfferDto() { }
|
||||
}
|
||||
|
||||
@@ -25,7 +25,7 @@ public static class CatalogEndpoints
|
||||
return Results.Ok(id);
|
||||
})
|
||||
.WithName("CreateCategory")
|
||||
.WithSummary("Создать категорию (Admin)");
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Создать категорию (Admin)", Description = "Создает новую категорию. Требуются права администратора." });
|
||||
|
||||
catalogGroup.MapGet("/categories", async (ISender sender) =>
|
||||
{
|
||||
@@ -33,7 +33,7 @@ public static class CatalogEndpoints
|
||||
return Results.Ok(result);
|
||||
})
|
||||
.WithName("GetCategories")
|
||||
.WithSummary("Получить все категории (плоский список с ParentId)");
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Получить все категории", Description = "Возвращает плоский список категорий с указанием ParentId для иерархии." });
|
||||
|
||||
// --- Услуги (Offers) ---
|
||||
|
||||
@@ -43,7 +43,7 @@ public static class CatalogEndpoints
|
||||
return Results.Ok(id);
|
||||
})
|
||||
.WithName("CreateOffer")
|
||||
.WithSummary("Создать оффер/услугу");
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Создать оффер/услугу", Description = "Создает новое предложение услуги в указанной категории." });
|
||||
|
||||
catalogGroup.MapGet("/offers/{id:guid}", async (Guid id, ISender sender) =>
|
||||
{
|
||||
@@ -51,6 +51,6 @@ public static class CatalogEndpoints
|
||||
return result is not null ? Results.Ok(result) : Results.NotFound();
|
||||
})
|
||||
.WithName("GetOfferById")
|
||||
.WithSummary("Получить детали услуги по ID");
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Получить детали услуги по ID", Description = "Возвращает полную информацию об услуге." });
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,4 +13,7 @@
|
||||
<ItemGroup>
|
||||
<FrameworkReference Include="Microsoft.AspNetCore.App" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -24,7 +24,9 @@ public static class GeoEndpoints
|
||||
var command = new UpdateGeoCommand(request.PerformerId, request.Latitude, request.Longitude, request.Status);
|
||||
await sender.Send(command, ct);
|
||||
return Results.Ok();
|
||||
});
|
||||
})
|
||||
.WithName("UpdateGeoStatus")
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Обновить геопозицию и статус", Description = "Обновляет координаты и статус исполнителя (Available, Busy, DayOff)." });
|
||||
|
||||
// GET /api/geo/nearby
|
||||
group.MapGet("nearby", async (
|
||||
@@ -36,7 +38,9 @@ public static class GeoEndpoints
|
||||
{
|
||||
var result = await sender.Send(new SearchNearbyQuery(lat, lon, radius), ct);
|
||||
return Results.Ok(result);
|
||||
});
|
||||
})
|
||||
.WithName("SearchNearby")
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Поиск исполнителей рядом", Description = "Возвращает список ID исполнителей в радиусе поиска." });
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -14,4 +14,8 @@
|
||||
<ItemGroup>
|
||||
<FrameworkReference Include="Microsoft.AspNetCore.App" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -16,13 +16,17 @@ public static class IdentityEndpoints
|
||||
{
|
||||
var result = await sender.Send(command);
|
||||
return Results.Ok(result);
|
||||
});
|
||||
})
|
||||
.WithName("Register")
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Регистрация пользователя", Description = "Регистрирует нового пользователя по номеру телефона и паролю." });
|
||||
|
||||
authGroup.MapPost("/login", async (LoginCommand command, ISender sender) =>
|
||||
{
|
||||
var token = await sender.Send(command);
|
||||
return Results.Ok(new { Token = token });
|
||||
});
|
||||
return Results.Ok(new LoginResponse(token));
|
||||
})
|
||||
.WithName("Login")
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Вход в систему", Description = "Аутентификация пользователя и получение JWT токена." });
|
||||
|
||||
var profileGroup = app.MapGroup("/api/profile").WithTags("Profile").RequireAuthorization();
|
||||
|
||||
@@ -30,6 +34,14 @@ public static class IdentityEndpoints
|
||||
{
|
||||
await sender.Send(new BecomePerformerCommand());
|
||||
return Results.Ok();
|
||||
});
|
||||
})
|
||||
.WithName("BecomePerformer")
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Стать исполнителем", Description = "Присваивает текущему пользователю роль исполнителя." });
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Ответ на успешный вход в систему.
|
||||
/// </summary>
|
||||
/// <param name="Token">JWT токен доступа.</param>
|
||||
public record LoginResponse(string Token);
|
||||
|
||||
@@ -13,4 +13,7 @@
|
||||
<ItemGroup>
|
||||
<FrameworkReference Include="Microsoft.AspNetCore.App" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4" />
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="MediatR" Version="14.0.0" />
|
||||
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.0" />
|
||||
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
@@ -44,7 +44,7 @@ public static class OrderEndpoints
|
||||
return Results.Ok();
|
||||
})
|
||||
.WithName("AddOrderApplication")
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Добавление отклика на заказ." });
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Добавление отклика на заказ.", Description = "Позволяет исполнителю откликнуться на заказ." });
|
||||
|
||||
group.MapPost("/{id:guid}/select-performer", async (Guid id, SelectPerformerRequest request, ISender sender) =>
|
||||
{
|
||||
@@ -53,35 +53,95 @@ public static class OrderEndpoints
|
||||
return Results.Ok();
|
||||
})
|
||||
.WithName("SelectPerformer")
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Выбор исполнителя для заказа." });
|
||||
.WithOpenApi(operation => new(operation) { Summary = "Выбор исполнителя для заказа.", Description = "Позволяет заказчику выбрать конкретного исполнителя." });
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Запрос на создание заказа.
|
||||
/// </summary>
|
||||
public record CreateOrderRequest(
|
||||
Guid CustomerId,
|
||||
Guid ServiceId,
|
||||
OrderType Type,
|
||||
string Address,
|
||||
double Latitude,
|
||||
double Longitude,
|
||||
DateTime? Deadline,
|
||||
Guid? PerformerId
|
||||
);
|
||||
public record CreateOrderRequest
|
||||
{
|
||||
/// <summary>
|
||||
/// Идентификатор заказчика.
|
||||
/// </summary>
|
||||
public Guid CustomerId { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Идентификатор услуги.
|
||||
/// </summary>
|
||||
public Guid ServiceId { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Тип заказа (прямой, публичный).
|
||||
/// </summary>
|
||||
public OrderType Type { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Текстовый адрес выполнения заказа.
|
||||
/// </summary>
|
||||
public string Address { get; init; } = default!;
|
||||
|
||||
/// <summary>
|
||||
/// Географическая широта места выполнения.
|
||||
/// </summary>
|
||||
public double Latitude { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Географическая долгота места выполнения.
|
||||
/// </summary>
|
||||
public double Longitude { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Крайний срок выполнения заказа (опционально).
|
||||
/// </summary>
|
||||
public DateTime? Deadline { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Идентификатор конкретного исполнителя (если прямой заказ).
|
||||
/// </summary>
|
||||
public Guid? PerformerId { get; init; }
|
||||
|
||||
public CreateOrderRequest() { }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Запрос на добавление отклика.
|
||||
/// </summary>
|
||||
public record AddApplicationRequest(
|
||||
Guid PerformerId,
|
||||
decimal Amount,
|
||||
string Currency,
|
||||
string Comment
|
||||
);
|
||||
public record AddApplicationRequest
|
||||
{
|
||||
/// <summary>
|
||||
/// Идентификатор исполнителя.
|
||||
/// </summary>
|
||||
public Guid PerformerId { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Сумма предложения.
|
||||
/// </summary>
|
||||
public decimal Amount { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Валюта предложения (например, RUB).
|
||||
/// </summary>
|
||||
public string Currency { get; init; } = "RUB";
|
||||
|
||||
/// <summary>
|
||||
/// Комментарий к отклику.
|
||||
/// </summary>
|
||||
public string Comment { get; init; } = default!;
|
||||
|
||||
public AddApplicationRequest() { }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Запрос на выбор исполнителя.
|
||||
/// </summary>
|
||||
public record SelectPerformerRequest(Guid PerformerId);
|
||||
public record SelectPerformerRequest
|
||||
{
|
||||
/// <summary>
|
||||
/// Идентификатор выбранного исполнителя.
|
||||
/// </summary>
|
||||
public Guid PerformerId { get; init; }
|
||||
|
||||
public SelectPerformerRequest() { }
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user