coolweb4 мар 2015 в 23:38

3 лучших инструмента для описания RESTful API

3 мин

128K

Проектирование API * Веб-разработка *

+15

Комментарии 19

uniqby 5 мар 2015 в 07:07

Буквально вчера искал что-то для себя и мне понравился вот этот инструмент apidocjs.com. Умеет генерировать приятную на глаз документацию прямо из комментариев к иходному коду (phpDoc).

Ghostwriter 5 мар 2015 в 07:24

raml.org

ArthurKushman 10 янв 2017 в 13:49

Тотально согласен — 2017г и RAML активно развили до версии 1.0
Запрогал авто-генератор для Laravel, с поддержкой JSON API — https://github.com/RJAPI/raml-json-api
(Контрибы и предметная критика приветствуется)

PS Insanity is doing the same thing over and over again, expecting different results. Albert Einstein
По сему коллеги — давайте перестанем «кодить» свои велосипеды и начнем работать с качественными форматами представления входных/выходных данных и их описанием. (нисколько не отменяет попыток изобретать что-нибудь новое, академически весомое)

Ghostwriter 5 мар 2015 в 07:28

Вопрос тем, кто использовал Swagger 2.0 и RAML. В чём их принципиальное отличие друг от друга? Какая из спецификаций охватывает большее число возможных кейсов (например, возможность явно указывать протокол)?

Tel 5 мар 2015 в 08:17

Slate?

asci 5 мар 2015 в 09:25

О, спасибо! очень крутая штука

Tel 5 мар 2015 в 09:34

Если будете делать что-то, напишите мне.
Мы давно хотим перевести наш АПИ с html файликов, на что-то такое, но руки всё не доходят.

KIVagant 22 мая 2015 в 11:04

Вы спасли мне жизнь :)
Лучшее из всего, что мне попадалось. Как всегда — просто тихим комментарием на гитхабе.

w32blaster 5 мар 2015 в 08:35

Ещё есть jsondoc.org/

Regis 5 мар 2015 в 08:47

Впечатляющая подборка. Целых два средства для описания RESTful API!

ha2bj 5 мар 2015 в 10:34

www.runscope.com/

coolweb 5 мар 2015 в 11:45

Тоже покадал на этот ресурс. Думаю, он будет хорошим дополнением к разработанному апи.

ha2bj 5 мар 2015 в 13:19

1 проект я уже пропустил через этот сервис (iOS + php). Очень удобный :)

ivlis 5 мар 2015 в 13:45

А можно кратно объяснить что это такое вообще и зачем оно нужно? Есть же ASN1 — стандарт описания интерфейсов с кучей написанных генераторов под какие угодно языки программирования?