Boas práticas para fornecer sua API

Então você quer oferecer uma API para que desenvolvedores consumam seus serviços ? Seguir algumas recomendações é importante para agilizar o trabalho de quem mantém quanto o trabalho de quem consome esses dados. Veja abaixo algumas dicar importantes que podem lhe auxiliar na hora de escrever seu repositório.

Deixe os verbos para os métodos

Usar verbos nos endpoints são completamente desnecessário. Verbos são indicados nos métodos que assinam os endpoints.

GET /get/user
GET /user

Prefira subdomínios

Simplifique a URL base (ou entrypoint) da sua API usando subdomínios ao invés de encadear em uma estrutura de subdiretórios.

http://api.example.com

é preferível a

http://example.com/api

Valor Nulo é melhor que campo omitido

Em casos onde um campo pode ou não retornar um valor, traga o campo, mesmo que nulo. Isso evita o desenvolvedor ter que verificar a existência do campo antes de poder usa-lo.