какво точно е перчене? И защо онлайн редакторът не изпълнява заявки?

Прекарах последните няколко дни, опитвайки се да разбера дали трябва да използвам api blueprint, RAML или swagger.

Изглежда, че swagger има най-голямата общност, но колкото по-внимателно се вглеждам, толкова повече усещам, че му липсва много документация (бях принуден да преглеждам кода много пъти, за да се опитам да го интегрирам с текущия си проект), много проблеми с github и stackoverflow въпросите са без отговор.

Възможно ли е да пропускам нещо тук? Всичко, което искам, е инструмент, който да ми помогне да напиша документацията за API и да тествам крайните точки.

Защо swagger трябва да стане част от логиката на сървъра?? Ако създам swagger файлове в редактора и след това ги предоставя на UI директно се поврежда..

Доколкото мога да преценя, това дори прави сървъра малко по-бавен и налага съществуването на много неумело поддържани интеграции :p Какво пропускам тук?


api swagger swagger-ui raml apiblueprint
person coiso    schedule 25.09.2014    source източник

Отговори (2)


arrow_upward
4
arrow_downward

Опитваме се да работим много върху подобряването на документацията на Swagger. Малко по-трудно е, когато много от проектите са ръководени от общността и не се управляват от една организация.

Всъщност се опитваме да отговаряме бързо на проблеми в github (не винаги успяваме) и имаме собствена група в Google за общи въпроси, така че следваме stackoverflow малко по-малко.

Редакторът, който споменахте, е нов инструмент като част от работата по Swagger 2.0 и все още не е окончателен. Като такъв, той все още има няколко грешки и липсващи функции. Потребителският интерфейс също е в процес на адаптиране към Swagger 2.0 и за него важат същите ограничения.

Със сигурност не е необходимо да го интегрирате с вашия сървър и можете да изложите документацията статично. Предимството на интегрирането му със сървъра е, че е по-лесно да се поддържа, ако API се промени.

person Ron    schedule 16.10.2014

arrow_upward
4
arrow_downward

Можете да опитате RAML + ramlev + Abao

Стъпките трябва да бъдат

  • Напишете API Spec в RAML с вашия любим редактор, т.е. Atom, vim
  • Валидирайте своя RAML с ramlev
  • Внедрете логиката на сървъра според API Spec
  • Валидирайте сървърната логика с Abao
person Quanlong    schedule 23.10.2014