Skip to content

Commit a5d9c1e

Browse files
authored
Merge pull request #89 from marcominerva/develop
Reorganize solution structure and update documentation
2 parents 3b47ac5 + a9b53c0 commit a5d9c1e

File tree

4 files changed

+29
-29
lines changed

4 files changed

+29
-29
lines changed

MinimalHelpers.slnx

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
<Solution>
2-
<Folder Name="/OpenApi/">
3-
<Project Path="src/MinimalHelpers.OpenApi/MinimalHelpers.OpenApi.csproj" />
4-
</Folder>
5-
<Folder Name="/Routing/">
6-
<Project Path="src/MinimalHelpers.Routing.Analyzers/MinimalHelpers.Routing.Analyzers.csproj" />
7-
<Project Path="src/MinimalHelpers.Routing/MinimalHelpers.Routing.csproj" />
8-
</Folder>
9-
<Folder Name="/Samples/">
2+
<Folder Name="/samples/">
103
<Project Path="samples/MinimalSample/MinimalSample.csproj" />
114
</Folder>
125
<Folder Name="/Solution Items/">
136
<File Path=".editorconfig" />
147
<File Path=".github/copilot-instructions.md" />
158
<File Path="src/Directory.Build.props" />
169
</Folder>
17-
<Folder Name="/Validation/">
10+
<Folder Name="/src/" />
11+
<Folder Name="/src/OpenApi/">
12+
<Project Path="src/MinimalHelpers.OpenApi/MinimalHelpers.OpenApi.csproj" />
13+
</Folder>
14+
<Folder Name="/src/Routing/">
15+
<Project Path="src/MinimalHelpers.Routing.Analyzers/MinimalHelpers.Routing.Analyzers.csproj" />
16+
<Project Path="src/MinimalHelpers.Routing/MinimalHelpers.Routing.csproj" />
17+
</Folder>
18+
<Folder Name="/src/Validation/">
1819
<Project Path="src/MinimalHelpers.FluentValidation/MinimalHelpers.FluentValidation.csproj" />
1920
<Project Path="src/MinimalHelpers.Validation.Abstractions/MinimalHelpers.Validation.Abstractions.csproj" />
2021
<Project Path="src/MinimalHelpers.Validation/MinimalHelpers.Validation.csproj" />

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,18 @@ A collection of helper libraries for Minimal API projects.
1111
[![Nuget](https://img.shields.io/nuget/v/MinimalHelpers.Routing)](https://www.nuget.org/packages/MinimalHelpers.Routing)
1212
[![Nuget](https://img.shields.io/nuget/dt/MinimalHelpers.Routing)](https://www.nuget.org/packages/MinimalHelpers.Routing)
1313

14-
A library that provides Routing helpers for Minimal API projects for automatic endpoints registration using Reflection.
15-
14+
A library that provides routing helpers for Minimal API projects, enabling automatic endpoint registration using reflection.
1615
### Installation
1716

18-
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.Routing). Just search for *MinimalHelpers.Routing* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
17+
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.Routing). Search for *MinimalHelpers.Routing* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
1918

2019
```shell
2120
dotnet add package MinimalHelpers.Routing
2221
```
2322

2423
### Usage
2524

26-
Create a class to hold your route handlers registration and have it implement the `IEndpointRouteHandlerBuilder` interface:
25+
Create a class to hold your route handler registrations and have it implement the `IEndpointRouteHandlerBuilder` interface:
2726

2827
```csharp
2928
public class PeopleEndpoints : MinimalHelpers.Routing.IEndpointRouteHandlerBuilder
@@ -41,7 +40,7 @@ public class PeopleEndpoints : MinimalHelpers.Routing.IEndpointRouteHandlerBuild
4140
}
4241
```
4342

44-
Call the `MapEndpoints()` extension method on the **WebApplication** object inside *Program.cs* before invoking the `Run()` method:
43+
Call the `MapEndpoints()` extension method on the **WebApplication** object in *Program.cs* before invoking the `Run()` method:
4544

4645
```csharp
4746
// using MinimalHelpers.Routing;
@@ -81,15 +80,15 @@ A library that provides a Source Generator for automatic endpoints registration
8180

8281
### Installation
8382

84-
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.Routing.Analyzers). Just search for *MinimalHelpers.Routing* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
83+
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.Routing.Analyzers). Search for *MinimalHelpers.Routing* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
8584

8685
```shell
8786
dotnet add package MinimalHelpers.Routing.Analyzers
8887
```
8988

9089
### Usage
9190

92-
Create a class to hold your route handlers registration and have it implement the `IEndpointRouteHandlerBuilder` interface:
91+
Create a class to hold your route handler registrations and have it implement the `IEndpointRouteHandlerBuilder` interface:
9392

9493
```csharp
9594
public class PeopleEndpoints : IEndpointRouteHandlerBuilder
@@ -110,7 +109,7 @@ public class PeopleEndpoints : IEndpointRouteHandlerBuilder
110109
> **Note**
111110
You only need to use the **MinimalHelpers.Routing.Analyzers** package. With this Source Generator, the `IEndpointRouteHandlerBuilder` interface is auto-generated.
112111

113-
Call the `MapEndpoints()` extension method on the **WebApplication** object inside *Program.cs* before the `Run()` method invocation:
112+
Call the `MapEndpoints()` extension method on the **WebApplication** object in *Program.cs* before the `Run()` method invocation:
114113

115114
```csharp
116115
app.MapEndpoints();
@@ -130,7 +129,7 @@ A library that provides OpenAPI helpers for Minimal API projects.
130129

131130
### Installation
132131

133-
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.OpenApi). Just search for *MinimalHelpers.OpenApi* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
132+
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.OpenApi). Search for *MinimalHelpers.OpenApi* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
134133

135134
```shell
136135
dotnet add package MinimalHelpers.OpenApi
@@ -140,7 +139,7 @@ dotnet add package MinimalHelpers.OpenApi
140139

141140
***Extension methods for OpenApi***
142141

143-
This library provides several extension methods that simplify the OpenAPI configuration in Minimal API projects. For example, it is possible to customize the description of a response using its status code:
142+
This library provides several extension methods that simplify the OpenAPI configuration in Minimal API projects. For example, you can customize the description of a response using its status code:
144143

145144
```csharp
146145
endpoints.MapPost("login", LoginAsync)
@@ -175,7 +174,7 @@ endpoints.MapPost("login", LoginAsync)
175174
.ProducesProblem(StatusCodes.Status404NotFound);
176175
```
177176

178-
To avoid multiple calls to `ProducesProblem`, use the `ProducesDefaultProblem` extension method provided by the library::
177+
To avoid multiple calls to `ProducesProblem`, use the `ProducesDefaultProblem` extension method provided by the library:
179178

180179
```csharp
181180
endpoints.MapGet("/api/people/{id:guid}", Get)
@@ -188,11 +187,11 @@ endpoints.MapGet("/api/people/{id:guid}", Get)
188187
[![Nuget](https://img.shields.io/nuget/v/MinimalHelpers.Validation)](https://www.nuget.org/packages/MinimalHelpers.Validation)
189188
[![Nuget](https://img.shields.io/nuget/dt/MinimalHelpers.Validation)](https://www.nuget.org/packages/MinimalHelpers.Validation)
190189

191-
A library that provides an Endpoint filter for Minimal API projects to perform validation with Data Annotations, using the <a href="https://github.com/DamianEdwards/MiniValidation">MiniValidation</a> library.
190+
A library that provides an endpoint filter for Minimal API projects to perform validation using Data Annotations and the <a href="https://github.com/DamianEdwards/MiniValidation">MiniValidation</a> library.
192191

193192
### Installation
194193

195-
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.Validation). Just search for *MinimalHelpers.Validation* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
194+
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.Validation). Search for *MinimalHelpers.Validation* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
196195

197196
```shell
198197
dotnet add package MinimalHelpers.Validation
@@ -275,11 +274,11 @@ You can use the `ValidationErrorTitleMessageFactory`, for example, if you want t
275274
[![Nuget](https://img.shields.io/nuget/v/MinimalHelpers.FluentValidation)](https://www.nuget.org/packages/MinimalHelpers.FluentValidation)
276275
[![Nuget](https://img.shields.io/nuget/dt/MinimalHelpers.FluentValidation)](https://www.nuget.org/packages/MinimalHelpers.FluentValidation)
277276

278-
A library that provides an Endpoint filter for Minimal API projects to perform validation using <a href="https://fluentvalidation.net">FluentValidation</a>.
277+
A library that provides an endpoint filter for Minimal API projects to perform validation using <a href="https://fluentvalidation.net">FluentValidation</a>.
279278

280279
### Installation
281280

282-
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.FluentValidation). Just search for *MinimalHelpers.FluentValidation* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
281+
The library is available on [NuGet](https://www.nuget.org/packages/MinimalHelpers.FluentValidation). Search for *MinimalHelpers.FluentValidation* in the **Package Manager GUI** or run the following command in the **.NET CLI**:
283282

284283
```shell
285284
dotnet add package MinimalHelpers.FluentValidation
@@ -368,4 +367,4 @@ You can use the `ValidationErrorTitleMessageFactory`, for example, if you want t
368367

369368
**Contributing**
370369

371-
The project is constantly evolving. Contributions are welcome! Please file issues or pull requests in the repository and they will be addressed as soon as possible.
370+
The project is constantly evolving. Contributions are welcome. Feel free to file issues and pull requests in the repository, and we'll address them as we can.

samples/MinimalSample/MinimalSample.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
<ItemGroup>
1010
<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="12.0.0" />
11-
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.8" />
11+
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.9" />
1212
<PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.4" />
13-
<PackageReference Include="TinyHelpers.AspNetCore" Version="4.1.4" />
13+
<PackageReference Include="TinyHelpers.AspNetCore" Version="4.1.6" />
1414
</ItemGroup>
1515

1616
<ItemGroup>

src/MinimalHelpers.OpenApi/MinimalHelpers.OpenApi.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@
3030
</ItemGroup>
3131

3232
<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
33-
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.19" />
33+
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.20" />
3434
</ItemGroup>
3535

3636
<ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
37-
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.8" />
37+
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.9" />
3838
</ItemGroup>
3939

4040
<ItemGroup>

0 commit comments

Comments
 (0)