iakimov May 16 2018 at 16:05

Поддержка документации в ASP.NET Web API

7 min

4.4K

.NET*ASP*C#*

From sandbox

Comments 9

alexs0ff May 16 2018 at 16:22

Но не было бы лучше, если бы сам ваш Web API обеспечивал доступ к своей документации

Swagger UI, не?

iakimov May 17 2018 at 11:19

Я не считаю, что описанный мною подход — замена для Swagger UI или NSwag. Просто иногда требуется еще что-то кроме описания синтаксиса методов: какие-то общие идеи, концепции, лежащие в основе работы сервиса. Мне кажется, что написанные человеком документы в некоторых случаях лучше.
Но, конечно, каждый выбирает решение, лучше подходящее под его ситуацию.

lair May 16 2018 at 16:39

… было бы лучше, если бы Web API отдавал документацию, которая заведомо совместима с кодом.

UFO just landed and posted this here

lair May 16 2018 at 17:58

и автосгенерированный код. Когда я знакомлюсь с API, мне кода не хочется, мне хочется примеров.

UFO just landed and posted this here

lair May 16 2018 at 18:12

Я ровно на это и намекал. Благо asp.net WebAPI это прекрасно умеет.

dmitry_dvm May 16 2018 at 17:34

Мои коллеги из компании Confirmit.

Эпично.

Скрин

Хотя может статья давно в песочнице лежит, что никаких коллег уж и нет.
А почему не NSwag и прочее подобное?

iakimov May 17 2018 at 11:23

Я считаю, что для некоторых случаев написанные человеком документы подходят лучше. Но, конечно, мое решение — не замена для NSwag и т.п. Так что каждый выбирает для себя.

Show the best of all time