microsoft / microsoft/api-guidelines

Which one to choose for error response RFC7807 specifications or Json API specifications or Microsoft's custom specifications

Open
#206 1 comment 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
23.3k
Forks
2.7k
PR merge metrics
No merged PRs in 30d

Description

.Net Core 3.0+ framework by default returns Problem details and following RFC7807 specifications to return model validation error or internal server error. Net core 3.0+ framework also expects us to write own CustomProblemDetailsFactory to extend these HTTP errors based on business logic exceptions. Looking at latest Net core framework, it seems like Microsoft is putting efforts into RFC7807 error specifications.
Azure ARM team is following their own error specifications which is some where close to Json-API specifications
Now question is which specifications we should follow where we are exposing bunch of external user facing APIs just like blob storage, cosmos db etc. services within Azure. We are building a new user facing Azure managed service. We also needed our own RP service so that ARM can call our APIs and ARM team has own specifications.
Should we use same ARM error specifications for user facing APIs (data-plane) for consistency or keep separate models ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository file or test is identified. Start by comparing RFC7807, JSON:API errors, and the Azure ARM error specifications described in the issue, then determine whether data-plane and ARM-facing APIs need shared models. Done means the chosen approach and its rationale are documented for the new Azure managed service.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api, backend-api-design
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.