Developing an API requires a balance between standardisation and implementation, mostly developers either get drowned in the details of various standards or miss the standards and begin the development in a non-uniform way. This chapter provides the information which has the balance between standards and implementation by providing the minimum set of guidelines covering the major aspects of a modern RESTful API like URI structure, HTTP verbs, versioning, error contracts and documentation. Also the implementation details are explained using ASP.NET Core API and Swagger. The guideline is a battle tested concrete minimum API standard guideline for any modern API requirement.
The chapter API Development is an extract of the book ‘Practical API Architecture and Development with Azure & AWS’ by Thurupathan Vijayakumar. Download the chapter above or purchase the full eBook here.