practical-api-guidelines
practical-api-guidelines copied to clipboard
Codit
Practical guidelines for building & designing APIs with .NET.
Would anyone ever do this? Should this be a "DO NOT" rule, or are there valid situations where this could be allowed.
Provide guidance for async processes where an endpoint is exposed to trigger it. Things that should be covered: - Response code - Suggestion would be `202 Accepted` - URL naming...
Provide automated process to generate PDF version of guidance. We should create official GitHub releases and create a PDF representation which is linked to the version that includes all the...
provide guidelines on content negotiation (accept / content-type).
You could include the type that is returned by this operation as well (typeof(CarDto[])). Actually, my take would be to specify a Produces attribute that covers the response of a...
consider to use the health check middleware (ASPNET core 2.2) https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/health-checks?view=aspnetcore-2.2
Each controller can also return a validation error, status code 400. Should we also include this in the swagger documentation, for completeness? In a similar way that the OK200 and...
Provide guidance on logging frameworks for ie logging exceptions. Ideas: - Cloud: - Application Insights - On-Prem: - ETW?