Skip to content

Commit 048a98a

Browse files
committed
- endpoint types clarification
1 parent b9eb381 commit 048a98a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,24 @@
2121

2222
## 🧩 Endpoint Types
2323

24-
### MinimalEndpoint
24+
### MinimalEndpoint
2525

26-
- **Purpose**: The barebone implementation for organizing ASP.NET Core Minimal APIs in REPR format endpoints.
27-
- **Usage**: Ideal for straightforward Minimal API implementations without additional processing.
26+
- **Purpose**: Structures ASP.NET Core Minimal APIs into the REPR pattern endpoints.
27+
- **Usage**: Best suited for implementing simple and straightforward Minimal API endpoints with clear separation of concerns.
2828

2929
### WebResultEndpoint
3030

31-
- **Purpose**: Transforms business results into HTTP responses.
32-
- **Usage**: Ideal for endpoints that need to return `IResult` types to the client.
31+
- **Purpose**: Converts business results into standardized HTTP responses, ensuring consistent and type-safe API behavior.
32+
- **Usage**: Perfect for centralizing and abstracting the logic of converting business results into HTTP responses.
3333

34-
### BusinessResultEndpoint
34+
### BusinessResultEndpoint
3535

36-
- **Purpose**: Returns raw business results without HTTP transformation.
37-
- **Usage**: Suitable for internal API layers where HTTP response formatting is unnecessary.
36+
- **Purpose**: Returns raw business results directly within an HTTP 200 OK response without additional formatting.
37+
- **Usage**: Ideal for internal API layers or scenarios where the raw business result is sufficient for the client.
3838

3939
### ServiceEndpoint
4040

41-
- **Purpose**: Designed for remote service consumption with strongly typed request and response models.
41+
- **Purpose**: Designed for simplifying remote service consumption with strongly typed request and response models.
4242
- **Usage**: Works in conjunction with the `ModEndpoints.RemoteServices` package to abstract HTTP plumbing on the client side.
4343

4444
> **Note**: For detailed information on each endpoint type, refer to the [Endpoint Types](./docs/EndpointTypes.md) documentation.

0 commit comments

Comments
 (0)