Добро пожаловать в форум, Guest  >>   Войти | Регистрация | Поиск | Правила | В избранное | Подписаться
Все форумы / Разработка информационных систем Новый топик    Ответить
 Как вы храните список ваших серверных REST API ?  [new]
u78
Member

Откуда: Москва
Сообщений: 603
У нас большая самописная система.

Фронт Javascript
Бэк REST API, C# + MS Sql
Протокол передачи JSON

Вырос большой зоопарк разных запросов с разными параметрами, для разных нужд.
Хочу описать все наши точки доступа к серверу: точка доступа, входные параметры, выходные и описание.

Вопрос - как это оформить, самое простое и быстрое в текстовом документе с поиском, но может есть какие то более удобные инструменты?
21 май 19, 13:49    [21889711]     Ответить | Цитировать Сообщить модератору
 Re: Как вы храните список ваших серверных REST API ?  [new]
Petro123
Member

Откуда: Загрузочный сектор Москвы (AutoPOI.ru)
Сообщений: 38643
u78,
А что вы там ищите и будете искать?
21 май 19, 13:57    [21889724]     Ответить | Цитировать Сообщить модератору
 Re: Как вы храните список ваших серверных REST API ?  [new]
u78
Member

Откуда: Москва
Сообщений: 603
Petro123
u78,
А что вы там ищите и будете искать?


Буду искать API по названию и по описанию.
Например нужны мне данные в каком то разрезе - открываю список API и смотрю там, ищу по ключевым словам или по названию таблицы с нужными данными.
21 май 19, 15:55    [21889851]     Ответить | Цитировать Сообщить модератору
 Re: Как вы храните список ваших серверных REST API ?  [new]
Petro123
Member

Откуда: Загрузочный сектор Москвы (AutoPOI.ru)
Сообщений: 38643
u78,
Должность какая?
Это API для разработчиков, а не менеджеров. Данные там искать.
21 май 19, 17:37    [21889954]     Ответить | Цитировать Сообщить модератору
 Re: Как вы храните список ваших серверных REST API ?  [new]
Serguei
Member

Откуда: Papua New Guinea
Сообщений: 683
u78
Вопрос - как это оформить, самое простое и быстрое в текстовом документе с поиском, но может есть какие то более удобные инструменты?


Почитайте на хабре статью "3 лучших инструмента для описания RESTful API".
22 май 19, 10:10    [21890332]     Ответить | Цитировать Сообщить модератору
 Re: Как вы храните список ваших серверных REST API ?  [new]
Дмитрий Мух
Member

Откуда: Зеленоград
Сообщений: 2561
u78,

мы используем Swagger.

Swagger is a language-agnostic specification for describing REST APIs.

https://docs.microsoft.com/en-US/aspnet/core/tutorials/web-api-help-pages-using-swagger
24 май 19, 10:49    [21892863]     Ответить | Цитировать Сообщить модератору
 Re: Как вы храните список ваших серверных REST API ?  [new]
u78
Member

Откуда: Москва
Сообщений: 603
Дмитрий Мух
u78,

мы используем Swagger.

Swagger is a language-agnostic specification for describing REST APIs.

https://docs.microsoft.com/en-US/aspnet/core/tutorials/web-api-help-pages-using-swagger


спасибо, интересная штучка
24 май 19, 18:41    [21893409]     Ответить | Цитировать Сообщить модератору
 Re: Как вы храните список ваших серверных REST API ?  [new]
hVostt
Member

Откуда:
Сообщений: 16178
u78,

redoc, open api (swagger)
26 май 19, 04:36    [21894011]     Ответить | Цитировать Сообщить модератору
 Re: Как вы храните список ваших серверных REST API ?  [new]
fkthat
Member

Откуда:
Сообщений: 1622
Гугли Swagger.
26 май 19, 20:03    [21894240]     Ответить | Цитировать Сообщить модератору
Все форумы / Разработка информационных систем Ответить