Auto-Api

Проект представляет собой:

Полностью автоматизированный API-документ, поддерживающий любой язык и фреймворк.

Преимущества:

1. После настройки автоматизация построения документа избавит от необходимости тратить больше усилий на обслуживание документации. Обновление API серверного программного обеспечения и синхронизированное обновление документации осуществляется простым нажатием кнопки.
2. Высокая степень настраиваемости, что облегчает адаптацию к специфическим стандартам разработки API (см. wiki).
3. Простота использования и установки (конкретные методы установки не были проверены на других компьютерах, при возникновении проблем рекомендуется связаться со мной).
4. Автор доступен для связи, и проблемы будут решены.

Характеристики:

• Поддержка серверных программ на любом языке и в любом фреймворке без вмешательства в код при создании API-документации.
• Быстрое создание и обновление API-документов одним нажатием после развёртывания, без необходимости написания строк документации.
• Высокая степень настраиваемости для различных стандартов API.
• Более точные и подробные документы по сравнению с ручными, облегчающие разработчикам понимание назначения параметров.
• Поддержка комментариев в формате markdown для сохранения пространства для ручного объяснения. Документы становятся более понятными.
• Детализированные модели с высокой степенью развязки и визуализации, предоставляющие удобное пространство для реализации третьим сторонам или скриптам.
• Поддержка аутентификации gitlab OAUTH2 для обеспечения безопасности и предотвращения утечки документов.
• Однократное создание документации базы данных.
• Использование vue.js + webpack для разработки интерфейса, обеспечивающего быструю реакцию и бесшовный опыт.
• Возможность быстрого тестирования и углубления понимания API через реальные запросы.

Интерфейс использования:

Обновление интерфейса от 2019-01-12, возможны дальнейшие изменения.

1. Главная страница:

2. Документация:

3. Поддержка однократного создания документации базы данных:

Архитектура программного обеспечения:

Зелёным цветом обозначена основная программа, жёлтым — опциональные части (включают некоторые вычисления для автоматического понимания API, которые можно игнорировать на начальном этапе).

Руководство по установке:

Смотрите wiki, если у вас возникли проблемы с установкой, свяжитесь со мной. Подробное руководство по начальной установке и настройке

Дополнительное содержание:

1. Некоторые детали можно найти в wiki этого проекта.
2. В настоящее время тестирование прокси-сервера базы данных проводилось только с PostgreSql. Требуется, чтобы связь не была зашифрована, тогда можно будет регистрировать влияние, которое вызывает запрос.

Незавершённое содержание:

См. issue, также можно создать новый issue для необходимых функций.

Участие и вклад:

1. Сообщите мне о проблемах, с которыми вы столкнулись во время использования, через Issue.
2. Поставьте звезду, чтобы сделать меня счастливым.
3. Внесите PR, я буду очень признателен.

Свяжитесь со мной:

Если у вас есть какие-либо вопросы по использованию, вы можете связаться со мной. QQ группа: 604437106