REST API Best Practices Standard Document helps to decide how our microservice should be designed. I have documented the standards which will help to build a microservice in a proper way. Best Practices for Better RESTful API is written by Kalpit Sharma and is available on GitHub.
Table of contents
Best Practices for Better RESTful APIIntroductionURI FormatField namingResponse DetailsHTTP Methods and HTTP Status CodesGETPOSTBulk PostPUTPATCHDELETEBulk DeleteVersioningError Handling Best PracticesResponse BodyError CodesReference ObjectsFilteringSimple FilteringSyntaxDetailsSwagger DocumentationComplex FilteringSyntaxDetailsSwagger DocumentationPaginationForward-Only PaginationRequest DetailsResponse DetailsExampleProjectionBest PracticesDefault FieldsExampleNotesMiscellaneousHealth APIVersion APIHeadersConclusionWrapping Up2 Comments
Sort: