phlank/responder

A C# package for .NET Core 3.1, .NET 5.0, and .NET 6.0 to cleanly build consistent API responses. Available via NuGet.

responder's Issues

Add tests for ApiResponseBehavior options

These tests need to make sure a new ApiResponseBuilder is generated when none exists and that an existing one only has the InvalidModelStateResponseFactory overridden.

JSON from responder should not interface data

If a response is successful, it should simply return the data to the client, not an object containing the data.

If a response is not successful, it should simply return the error to the client.

The successful property should remain, but shouldn't be serialized.

Set up options to use the Options pattern

Fix warnings from missing documentation

Create Github Pages for generated docs

Add option for charset, let default be utf-8

Remove extensive details from README.md

Add WithException and WithExceptions to the ApiResultBuilder

Don't leak any type of system information (like stack trace); only reveal a type, description, and error code

Target both NET Core 3.1 and NET 5

Finish linking statuses to default types

Remove ApiError and switch to ProblemDetails, which is standard with ASP.NET Core

Create homepage documentation

Reformat the ApiError to follow the RFC7807 standards

Make the JsonResult returned by the IApiResponseBuilder follow the RFC7807 when an error is present

The first error in the Errors of the ApiResponse should be the one used for the main content and HTTP status code of the response.

Any errors after the first should be put into the Extensions dictionary under the "OtherErrors" key with an array value containing all of those errors.

Abstract away all NET Core 3.1 implementations of IApiResult

Create unit tests

Add Github Workflow for building and testing

Set up the main package details and create the nuspec configuration file

Break ProblemDetails extensions from Responder into its own library

Add documentation comments to public items of the library

Return a JsonResult object from the response builder

This will allow us to reflect status code and content type, as well as pass in response-specific serializer settings in use

Add WithProblem to IApiResponseBuilder

Switch github workflows for all non-documentation builds back over to ubuntu for speed

Upgrade example to NET 5.0

Design usage for responding with files

Shouldn't deviate too much from the current workflow, though there will likely need to be some deviation.

One option is to allow someone to insert a byte array as content, then use a method like BuildAsFile to create the response. This may return something like a DownloaderResult which would extend the existing ASP.NET Core FileContentResult.

This requires more thought into the workflow and usage of the responder to make it feel as cohesive as it can

When an error is added, the HTTP response code should be reflected in the response of the API

Add AddProblem and AddProblems to the Responder

Methods should take a ProblemDetail and IEnumerable respectively

Add .gitattributes

Upgrade package to NET 5.0

Change "WithX" methods in Responder to "AddX"

Rename project to Phlank.Responder

Next version will be a new package in NuGet, as v1.0.0

Rename github repository as well, change all namespaces, etc.

Add WithStatusCode to the IApiResponseBuilder

Should accept an HttpStatusCode, and this will be the status code of the response if there are no errors.

Add Build<T> to IApiResultBuilder

Should return an ApiResult

Add code coverage from Coverlet obtained via GIthub workflows to README.md

Use the dotnet generated .gitignore

Add option for XML response

Should use the built in XmlResult

Create installation guide documentation

Add constructor for ApiError with guards

Add tests for the ApiResponseBuilder

Make the override of the default InvalidModelStateResponseFactory more useful/complete

The default factory is fully sufficient according to RFC guidelines thus far and thus doesn't need to be replaced.

Create a project logo

Update to NET 6