Должна ли внутренняя ошибка сервера документироваться в чванстве? - PullRequest
0 голосов
/ 04 марта 2019

Я пишу новый API и документирую его с помощью Swagger / OpenAPI.Кажется, это хороший стандарт для документирования ответов об ошибках, с которыми может столкнуться разработчик.Но я не могу найти какие-либо руководящие принципы или лучшие практики по поводу внутренней ошибки сервера.Теоретически любой путь может создать необработанное исключение.Я не ожидаю, что это произойдет, но это может произойти.Должны ли все пути иметь ответ с кодом состояния 500 «Внутренняя ошибка сервера» или я должен только документировать ответы, с которыми разработчик может что-либо сделать, например, 2xx, 3xx и 4xx?

...