Recent Posts
-
January 04, 2022
Enriched Web API Documentation using Swagger/OpenAPI in ASP.NET Core
Keeping an up to date Web API documentation that provides all the necessary information (endpoints, data contracts, authorization, etc.) is challenging and requires time and effort. Let's simplify it by providing enriched API Documentation using Swagger/OpenAPI via the Swashbuckle tools.
-
December 04, 2021
All about Web API Versioning in ASP.NET Core
Web API Versioning is not just mapping a version to each controller or action. We should decide the used version mechanism(s) and how organize our controller actions and code files. We may need a versioning plan, depending on the number of versions we will serve and maintain. So, let's dig in.
-
November 04, 2021
REST Web API in Practice: Improving towards Perfection
Designing REST Web APIs in practice has many challenges. However, our decisions can improve our Web APIs usability, extensibility, performance, etc. So let's see how Caching, HATEOAS, Media Types, and consistent and meaningful use of HTTP status codes can help us.
-
October 04, 2021
REST Web API in Practice: Naming Endpoints, Filtering, Sorting, and Pagination
In computer science, naming things is hard! When designing and naming the URLs structure, various questions and possible conflicts between the team members may arise. Let's see some practical suggestions for consistently naming our REST endpoints and representing the filtering, sorting, and pagination operations as URL query string parameters.
-
September 04, 2021
Designing a RESTful Web API
An API can provide flexibility in our source code, product, and teams. Let's see which key points we should consider when designing an API and how the REST constraints (principles) guide us to create a RESTful or REST-Based Web API.