Report about Swagger API framework, its advantages, tools, libraries and comparing with other frameworks and its first version.

1. Swagger

2. Зачем использовать
API фреймворки?
• Автогенерация кода
• Документация
• Автовалидация
• Тесты
• Клиент
• Красивый UI

3. UI

4. Editor

5. Swagger 2.0 ≠ Swagger 1.2
– Почти полная поддержка JSON schema
– Смена идеологии
– Поддержка YAML
– Новый формат полей

6. Спецификация

7. Параметры
{

8. Параметры

9. Модели
– Наследование
– Полиморфизм
– Ссылки

10. Авторизация
Тип Заголовок
Basic
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
ApiKey
api_key: 22555afccfcd7c2e32392a027
OAuth2 Authorization: Bearer mF_9.B5f-4.1JqM

11. Top-down vs Bottom-up
спецификация
реализация

12. swagger-node-express

13. swaggerize-express

14. swagger-codegen
C#
+ templates
client + server
+ docs
2.0

15. Что есть еще

16. Apiblueprint

17. – YAML
– !include
– traits
WORKGROUP:

18. WADL

19. Выводы
• Большое сообщество и экосистема (>45 сервисов)
• Поддержка большого кол-ва языков (>13)
• Богатые возможности спецификации
• Визуальные инструменты
• Платформонезависимость
• Зоопарк сторонних библиотек
• Несоответствия библиотек спецификациям
• Исторически bottom-top идеология
+
–

20. Спасибо
@raxpost
http://yarax.ru
http://facebook.com/raxwunter