api-guidelines
api-guidelines copied to clipboard
microsoft
Microsoft REST API Guidelines
I heard someone claiming the URL for a collection should be have trailing slash, for example `GET https://example.com/v1/articles/`. And that a popular [stack exchange answer](https://softwareengineering.stackexchange.com/questions/186959/trailing-slash-in-restful-api) also advocates for it. Does...
While it's easy to design API around the concept of Create, Read, Update, Delete, often services need to support actions which don't map well to CRUD nor to HTTP methods....
This is related to #105. If the guidelines were in README.md, turning on GitHub Pages is a matter of clicking one button and then the link could be included in...
Are there any naming convention for bulk operations? The best one I found on a Google search is [here](https://github.com/NationalBankBelgium/REST-API-Design-Guide/wiki/Bulk-operations-Resources-naming-convention), which seems good. But I would adopt things published by Microsoft...
Frequently, there are filter expressions where the same attribute is compared with multiple values like - `$filter=categoryId eq 'cat1000' or categoryId eq 'cat1001' or categoryId eq 'cat1002'` It is very...
ASPNET Core 2.2 [implements ProblemDetails specification](https://blogs.msdn.microsoft.com/webdev/2018/09/12/asp-net-core-2-2-0-preview2-now-available/) while Microsoft API Guidelines [advises a different error structure to be served](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). Is the guideline supposed to align with [RFC 7807](https://tools.ietf.org/html/rfc7807) at some point...
If an object contains inherent dictionaries (that usually contain custom keys) in its properties, like: `{ id: '1234' customInfo: { customProperty1: value1, customProperty2: value2} }` How is it expected to...
Hi, The guidelines describe that collections should have a `@nextLink` attribute. However, in practice some Microsoft services use `nextLink` (without `@`). See https://azure.github.io/projects/apis/#!/DeploymentOperations/DeploymentOperations_List for example. What is preferred? I can...
Are their any validation tools or compliance test suites available to verify that an API follows these guidelines?
Given [section 4.2, "Guidelines for existing services and versioning of services"](https://github.com/Microsoft/api-guidelines/blob/5beb5c39bd611b7bc1c6544de5fdd8a3a1991242/Guidelines.md#42-guidelines-for-existing-services-and-versioning-of-services) > We do not recommend making a breaking change to a service that pre-dates these guidelines simply for compliance...
