Convenções de nomes em REST API: URLs, métodos e chaves JSON

Uma REST API bem nomeada é intuitiva, consistente e autodocumentada. A maioria das APIs de produção segue estas convenções.

Convenções de caminho URL

• Use kebab-case ou minúsculas para os caminhos URL: /user-profiles
• Use substantivos no plural para coleções: /users, /orders
• Use IDs de recurso para itens individuais: /users/123
• Aninhe sub-recursos: /users/123/orders
• Evite verbos nas URLs: POST /users e não POST /create-user

Métodos HTTP

Método	Finalidade	Exemplo
GET	Ler	GET /users/123
POST	Criar	POST /users
PUT	Atualização completa	PUT /users/123
PATCH	Atualização parcial	PATCH /users/123
DELETE	Excluir	DELETE /users/123

Chaves de resposta JSON

Use camelCase (estilo Google) ou snake_case (estilo GitHub/Stripe). Escolha um e seja consistente em todos os endpoints.

Parâmetros de consulta

Use snake_case ou camelCase de forma consistente: ?page_size=20&sort_by=created_at

Converter formatos

Conversor para kebab-case para URLs, camelCase ou snake_case para chaves JSON. Experimente o hub.