Гость
Войти | Профиль | Очистить
Целевая тема:
Создать новую тему:
Автор:
Действия ...
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Как вы храните список ваших серверных REST API ? / 9 сообщений из 9, страница 1 из 1
21.05.2019, 13:49
    #39815795
u78
u78
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
У нас большая самописная система.

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

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

Вопрос - как это оформить, самое простое и быстрое в текстовом документе с поиском, но может есть какие то более удобные инструменты?
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
21.05.2019, 13:57
    #39815805
Petro123
Petro123
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
u78,
А что вы там ищите и будете искать?
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
21.05.2019, 15:55
    #39815885
u78
u78
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
Petro123u78,
А что вы там ищите и будете искать?

Буду искать API по названию и по описанию.
Например нужны мне данные в каком то разрезе - открываю список API и смотрю там, ищу по ключевым словам или по названию таблицы с нужными данными.
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
21.05.2019, 17:37
    #39815957
Petro123
Petro123
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
u78,
Должность какая?
Это API для разработчиков, а не менеджеров. Данные там искать.
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
22.05.2019, 10:10
    #39816215
Serguei
Serguei
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
u78Вопрос - как это оформить, самое простое и быстрое в текстовом документе с поиском, но может есть какие то более удобные инструменты?

Почитайте на хабре статью "3 лучших инструмента для описания RESTful API".
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
24.05.2019, 10:49
    #39817571
Дмитрий Мух
Дмитрий Мух
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
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
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
24.05.2019, 18:41
    #39817966
u78
u78
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
Дмитрий Мух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

спасибо, интересная штучка
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
26.05.2019, 04:36
    #39818312
hVostt
hVostt
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
u78,

redoc, open api (swagger)
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
26.05.2019, 20:03
    #39818461
fkthat
fkthat
Участник
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Как вы храните список ваших серверных REST API ?
Гугли Swagger.
...
Рейтинг: 0 / 0
| Ответить | Цитировать | Написать  
Форумы / Разработка информационных систем [игнор отключен] [закрыт для гостей] / Как вы храните список ваших серверных REST API ? / 9 сообщений из 9, страница 1 из 1
Найденые пользователи ...
Разблокировать пользователей ...
Читали тему (0):
Читали форум (0):
Пользователи онлайн (0):
Польз. соглашение
созд. / загр.: 167ms
Закрыть
start [/forum/topic.php?fid=33&mobile=1&tid=1547156]:
 0ms
get settings:
 10ms
get forum list:
 13ms
check forum access:
 4ms
check topic access:
 4ms
track hit:
 60ms
get topic data:
 10ms
get forum data:
 2ms
get page messages:
 52ms
get tp. blocked users:
 1ms
others: 11ms
total:  167ms
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]