dotnet / AspNetCore.Docs

Documentation for ASP.NET Core
https://docs.microsoft.com/aspnet/core
Creative Commons Attribution 4.0 International
12.57k stars 25.31k forks source link

What if my app is a REST API only? #15177

Closed Paul-Dempsey closed 4 years ago

Paul-Dempsey commented 4 years ago

All the content on this page ()and pretty much the whole Net Core docs) presumes you are generating UI pages. My app is a pure REST API with no UI. How do a wire up error handling so that my result json is like what is described in https://tools.ietf.org/html/rfc7807 or https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#7102-error-condition-responses?


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

guardrex commented 4 years ago

Did you see this one :point_right: https://docs.microsoft.com/en-us/aspnet/core/web-api/handle-errors?view=aspnetcore-3.0

Paul-Dempsey commented 4 years ago

Ha! Obviously not. I landed in the other area by web search (like everyone enters the docs).

Can we please add cross references (See Also) so we can get to the right place?

Thanks! :- Paul

From: Luke Latham notifications@github.com Sent: Thursday, October 17, 2019 5:52 PM To: aspnet/AspNetCore.Docs AspNetCore.Docs@noreply.github.com Cc: Paul Dempsey Paul.Dempsey@microsoft.com; Author author@noreply.github.com Subject: Re: [aspnet/AspNetCore.Docs] What if my app is a REST API only? (#15177)

Did you see this one 👉 https://docs.microsoft.com/en-us/aspnet/core/web-api/handle-errors?view=aspnetcore-3.0https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Faspnet%2Fcore%2Fweb-api%2Fhandle-errors%3Fview%3Daspnetcore-3.0&data=02%7C01%7CPaul.Dempsey%40microsoft.com%7C24509819d1af4ea8d0ce08d753655bf6%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637069567112507924&sdata=jKOrU9TGkSSeUWJGz4Vj01V7ErYwCiUjRJhHa7HAITk%3D&reserved=0

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Faspnet%2FAspNetCore.Docs%2Fissues%2F15177%3Femail_source%3Dnotifications%26email_token%3DAF7S4CUSFSCZEPF4YTIQ3JDQPECCLA5CNFSM4JCBD5L2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEBSBTXI%23issuecomment-543431133&data=02%7C01%7CPaul.Dempsey%40microsoft.com%7C24509819d1af4ea8d0ce08d753655bf6%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637069567112507924&sdata=0NJQMlW%2FOWXIhzU5xLkzs2w%2FSp1g5iMc6Kx4FLHQmA4%3D&reserved=0, or unsubscribehttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAF7S4CWUNSXEE4GLXKDLVTTQPECCLANCNFSM4JCBD5LQ&data=02%7C01%7CPaul.Dempsey%40microsoft.com%7C24509819d1af4ea8d0ce08d753655bf6%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637069567112507924&sdata=vmO7T%2F2ct22efXFD%2B1Qpim0s98tagmp6FYZ3ptq%2Bvew%3D&reserved=0.

Paul-Dempsey commented 4 years ago

Actually, I was in the Fundamentals section, were I would expect to see information relevant for both Web apps and API apps, so the defect stands: Fundamentals should cover both uses case, or point to the specialized Error Handling topics .The Fundamentals page has no cross references to indicate that there is more specific related information.

Thanks, :- Paul

From: Paul Dempsey Sent: Thursday, October 17, 2019 6:10 PM To: aspnet/AspNetCore.Docs reply@reply.github.com; aspnet/AspNetCore.Docs AspNetCore.Docs@noreply.github.com Cc: Author author@noreply.github.com Subject: RE: [aspnet/AspNetCore.Docs] What if my app is a REST API only? (#15177)

Ha! Obviously not. I landed in the other area by web search (like everyone enters the docs).

Can we please add cross references (See Also) so we can get to the right place?

Thanks! :- Paul

From: Luke Latham notifications@github.com<mailto:notifications@github.com> Sent: Thursday, October 17, 2019 5:52 PM To: aspnet/AspNetCore.Docs AspNetCore.Docs@noreply.github.com<mailto:AspNetCore.Docs@noreply.github.com> Cc: Paul Dempsey Paul.Dempsey@microsoft.com<mailto:Paul.Dempsey@microsoft.com>; Author author@noreply.github.com<mailto:author@noreply.github.com> Subject: Re: [aspnet/AspNetCore.Docs] What if my app is a REST API only? (#15177)

Did you see this one 👉 https://docs.microsoft.com/en-us/aspnet/core/web-api/handle-errors?view=aspnetcore-3.0https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Faspnet%2Fcore%2Fweb-api%2Fhandle-errors%3Fview%3Daspnetcore-3.0&data=02%7C01%7CPaul.Dempsey%40microsoft.com%7C24509819d1af4ea8d0ce08d753655bf6%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637069567112507924&sdata=jKOrU9TGkSSeUWJGz4Vj01V7ErYwCiUjRJhHa7HAITk%3D&reserved=0

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Faspnet%2FAspNetCore.Docs%2Fissues%2F15177%3Femail_source%3Dnotifications%26email_token%3DAF7S4CUSFSCZEPF4YTIQ3JDQPECCLA5CNFSM4JCBD5L2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEBSBTXI%23issuecomment-543431133&data=02%7C01%7CPaul.Dempsey%40microsoft.com%7C24509819d1af4ea8d0ce08d753655bf6%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637069567112507924&sdata=0NJQMlW%2FOWXIhzU5xLkzs2w%2FSp1g5iMc6Kx4FLHQmA4%3D&reserved=0, or unsubscribehttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAF7S4CWUNSXEE4GLXKDLVTTQPECCLANCNFSM4JCBD5LQ&data=02%7C01%7CPaul.Dempsey%40microsoft.com%7C24509819d1af4ea8d0ce08d753655bf6%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637069567112507924&sdata=vmO7T%2F2ct22efXFD%2B1Qpim0s98tagmp6FYZ3ptq%2Bvew%3D&reserved=0.