apihub
v1.3.0
Мы пытаемся построить один концентратор API одного источника, который можно использовать для изучения обработки API на любом языке программирования. Пользователи могут создавать свой фронтальный портфель в веб -приложениях и мобильных приложениях, используя этот концентратор API.
Проект Freeapi-это инновационная и общественная инициатива, направленная на предоставление разработчикам бесплатных и доступных API для своих проектов.
Проект фокусируется на предоставлении широкого спектра API, которые обслуживают различные области и функции, что позволяет разработчикам плавно интегрировать эти API в свои приложения.
Ключевые основные моменты проекта Freeapi включают:
Доступность: Проект Freeapi привержен ликвидации барьеров путем предоставления бесплатного доступа к своей коллекции API. Разработчики могут использовать эти API без каких -либо ограничений затрат, позволяя им экспериментировать, учиться и создавать инновационные приложения.
Разнообразная коллекция API: проект предлагает разнообразную и всеобъемлющую коллекцию API, которые охватывают разные отрасли, области и функциональные возможности. Нужно ли вам интеграции в социальных сетях, платежные шлюзы, алгоритмы машинного обучения или подключение к устройству IoT, проект Freeapi раскрыл вас.
Упрощенная интеграция: проект Freeapi понимает проблемы, с которыми сталкиваются проблемы при интеграции API в свои приложения. Чтобы решить это, проект предоставляет четкую документацию, образцы кода и SDK, упрощая процесс интеграции и сокращение времени и усилий разработки.
Развитие сообщества: проект способствует оживленному и совместному сообществу разработчиков. Участникам рекомендуется поделиться своими знаниями, участвовать в дискуссиях и сотрудничать в проектах, связанных с API. Эти коллективные усилия обеспечивают постоянное улучшение и надежность API, предлагаемых проектом Freeapi.
Обучение и развитие навыков: проект Freeapi направлен на расширение возможностей разработчиков путем предоставления платформы для обучения и развития навыков. Благодаря доступу к различным API и образовательным ресурсам, разработчики могут улучшить свое понимание интеграции API, расширить свои знания и продемонстрировать свой опыт посредством создания полных проектов.
В целом, проект Freeapi является ценным ресурсом для разработчиков, ищущих доступные и разнообразные API.
Способствуя поддерживающему сообществу, проект дает возможность разработчикам изучать, создавать и инновации, в конечном итоге способствуя росту и развитию ландшафта интеграции API.
Представление нашего новаторского проекта API Hub с открытым исходным кодом, динамическая платформа, предназначенная для революции способа взаимодействия разработчиков с API.
С акцентом на открытость, доступность и обучение, наш центр API дает разработчикам все уровни изучать, экспериментировать и развивать свои навыки в интеграции API.
Основные моменты:
Открытый исходный код: наш концентратор API построен на принципах открытого исходного кода, обеспечивая прозрачность, сотрудничество и развитие, управляемое сообществом. Это означает, что исходный код свободно доступен, что позволяет разработчикам настраивать, расширять и вносить свой вклад в проект.
БЕСПЛАТНО ИСПОЛЬЗОВАНИЕ: Мы твердо верим в удаление барьеров для входа, поэтому наш концентратор API полностью свободен в использовании. Независимо от того, являетесь ли вы опытным разработчиком или только начинаете свое путешествие по кодированию, вы можете использовать нашу платформу без каких -либо ограничений затрат.
Локальное или развертывание : гибкость лежит в основе нашего центра API. У вас есть возможность использовать его локально, запустить на собственной машине или развернуть на сервере, что делает его доступным для других. Эта универсальность гарантирует, что вы можете адаптировать платформу к вашей конкретной среде разработки.
Учебный ресурс : наш концентратор API разработан как комплексный учебный ресурс, предлагающий множество образовательных материалов, учебных пособий и документации. Независимо от того, являетесь ли вы новичком или стремитесь расширить свои знания API, наша платформа предоставляет ресурсы, необходимые для изучения и улучшения.
Пользовательские конечные точки для начинающих : для разработчиков на уровне начинающих наш концентратор API предлагает пользовательские конечные точки, которые обеспечивают практический опыт работы с ответами API. Эти API-интерфейсы, удобные для начинающих, позволяют вам практиковать и ознакомиться с основами работы с API.
Усовершенствованные API для построения портфеля : в дополнение к конечным точкам на уровне начинающих, наш концентратор API также предоставляет расширенные API для оспаривания и расширения ваших навыков. Эти API позволяют вам справиться с более сложными сценариями интеграции, помогая вам создать надежный портфель проектов, чтобы продемонстрировать ваш опыт.
Объединяя принципы, доступность и акцент на обучение с открытым исходным кодом и акцент на обучении, наш проект API Hub прокладывает путь для разработчиков в мире интеграции API. Присоединяйтесь к нашему оживленному сообществу и отправляйтесь в захватывающее путешествие по открытиям, росту и инновациям.
Наш проект с открытым исходным кодом в настоящее время размещен на удаленном сервере, где мы вынуждены сбросить весь сервер, включая файловую систему и базу данных MongoDB , каждые 2 часа, чтобы избежать дополнительных затрат.
Этот процесс приводит к удалению всех изображений/статических файлов и сброса всей базы данных на сервере.
Потеря данных: любые изменения, внесенные в течение 2-часового интервала (на удаленном сервере), включая загруженные изображения и пользовательские данные, будут потеряны и невозможно.
Прерывание службы: сброс сервера может нарушить ваши процессы разработки и тестирования в течение определенной продолжительности при перезагрузке сервера (в течение 1-2 минуты).
Местное использование API: для целей разработки и тестирования мы настоятельно рекомендуем использовать API локально на вашей машине, клонируя проект .
Это гарантирует, что сброс сервера не влияет на вашу работу, и позволяет вам поддерживать стабильную среду разработки на вашей локальной машине.
Самостоятельное управление на железной дороге (рекомендуется для личных проектов) : чтобы самостоятельно управлять приложением Freeapi.App, вы можете воспользоваться предварительно созданным шаблоном, который легко доступен. Нажмите здесь для подробных документов
Чтобы запустить проект Freeapi, выполните эти шаги:
.env -файл в корневой папке и скопируйте содержимое .env.sample и добавьте необходимые учетные данные.docker-compose up --build --attach backend
# --build: Rebuild the image and run the containers
# --attach: only show logs of Node app container and not mongodbЧтобы запустить проект Freeapi локально, выполните эти шаги:
.env -файл в корневой папке и скопируйте содержимое .env.sample и добавьте необходимые учетные данные.yarn installyarn startДля самостоятельного приложения Freeapi.App вы можете воспользоваться предварительно созданным шаблоном, который легко доступен.
Нажмите кнопку выше, чтобы посетить Railway.app.
Нажмите кнопку «Развернуть сейчас» .
(Необязательно) Войдите с GitHub для развертывания.
Заполните детали репозитория:
Для переменных среды мы предоставили некоторые значения по умолчанию в ENV для снижения бремени, но некоторые параметры являются обязательными:
PORT : не изменяйте значение, пусть будет установлено на 8080, чтобы просмотреть документы Swagger после развертывания.MONGODB_URI : Предоставьте URL базы данных MongoDB Atlas. Пример предварительно заполнен для вас, отредактируйте/обновите его, чтобы продолжить.NODE_ENV : по умолчанию установлено значение «разработка» для просмотра журналов. Вы можете изменить его на «Производство» (обязательно добавьте точное слово), чтобы скрыть их.EXPRESS_SESSION_SECRET : рекомендуется изменить значение по умолчанию на ваше собственное значение секрета.ACCESS_TOKEN_SECRET : рекомендуется изменить значение по умолчанию на ваше собственное значение секрета.ACCESS_TOKEN_EXPIRY : установить на 1 день по умолчанию.REFRESH_TOKEN_SECRET : рекомендуется изменить значение по умолчанию на ваше собственное значение секрета.REFRESH_TOKEN_EXPIRY : установите на 10 дней в качестве дефолта.FREEAPI_HOST_URL : установить его в виде сгенерированного URL.После того, как вы заполняете необходимые параметры среды, если вы решите добавить других, таких как PayPal, Google и Razorpay, пожалуйста, упомяните ваши учетные данные в форме.
Нажмите кнопку «Развертывание» , чтобы запустить первую сборку.
Примечание. Как только приложение будет развернуто, подождите 3-5 минут, пока документы Swagger будут доступны.
Чтобы обеспечить надежность и стабильность для наших конечных пользователей, мы используем Playwright, мощную структуру тестирования для автоматизации тестирования во всех конечных точках.
Обязательно добавьте MONGO_MEMORY_SERVER_PORT=10000 (порт mongodb для тестирования E2E) в вашем файле .env .
yarn start:test-serveryarn test:playwrightЭто генерирует отчет о драматурге. Для просмотра этого отчета запустите следующую команду
yarn playwright show-reportУбедитесь, что все тестовые примеры передаются всякий раз, когда вы вносите какие -либо изменения.
Мы приветствуем ваш интерес к участию в нашем проекте с открытым исходным кодом!
Чтобы внести свой вклад в Freeapi, следуйте этим шагам:
git checkout -b feat/your-feature-name или git checkout -b fix/your-bug-fix-name и внесите свои изменения.git commit -am 'add your commit message'git push origin feat/your-feature-name .Вот руководство о том, как вы можете эффективно внести свой вклад в наш концентратор API:
Получите запросы на обновления README: Пожалуйста, воздержитесь от отправки запросов на вывод исключительно для обновления файла README проекта. Хотя мы ценим важность четкой и краткой документации, мы предпочитаем сосредоточиться на существенных вкладах кода и улучшениях функций.
Обновления грамматики: наша команда ценит эффективное общение, но мы не грамматические наставщики. Вам не нужно отправлять запросы на притяжение исключительно на грамматические исправления или незначительные улучшения языка. Вместо этого сосредоточьтесь на основных функциональных возможностях и функциях проекта.
Избегайте обновления существующих публичных API: Для поддержания стабильности и последовательности мы препятствуем прямым обновлениям существующих публичных API в центре API. Эти API были тщательно проверены и утверждены. Однако, если вы сталкиваетесь с какими -либо ошибками или проблемами, мы рекомендуем вам открыть проблему по трекеру вопросов нашего проекта, чтобы уведомить нас.
Создание новых API проекта: мы рекомендуем вам изучить ваше творчество и внести свой вклад, создав полный API проекта. Эти API должны предоставлять комплексные решения, которые могут помочь разработчикам в создании сложных проектов, чтобы продемонстрировать свои навыки и способности. Ваш вклад в эту область в значительной степени принесет пользу сообществу.
Составьте предложение и обсудите Discord: Прежде чем погрузиться в ваш проект, мы рекомендуем составить предложение. Это может включать в себя карту разума или набросок API, который вы намерены создать, и его потенциальные преимущества. Присоединяйтесь к нашему сообществу Discord, где вы можете поделиться своим предложением, обсудить идеи и собрать отзывы от других участников. Привлечение этих дискуссий улучшит ваш бэкэнд -портфель и поможет сформировать будущее направление проекта.
Мы ценим ваш энтузиазм и с нетерпением ждем вашего ценного вклада в наш проект API с открытым исходным кодом.
Вместе мы можем способствовать совместной среде и оказать значительное влияние на ландшафт интеграции API.
Нажмите здесь для подробного руководства взноса.
Спасибо за ваш интерес к участию в проекте Freeapi, создав Frontend Applications, потребляющие Freeapis! Ваши усилия играют решающую роль в повышении опыта пользователя и расширении охвата наших API. Пожалуйста, следуйте этому руководству, чтобы обеспечить плавный и совместный процесс вклада.
Нажмите здесь для подробного руководства по взносу для разработчиков Frontend!
Спасибо за ваш интерес к участию в проекте Freeapi, чтобы увеличить охват кода нашего сервиса API, который помогает нам отправить надежные конечные точки, протестированные на поле битвы. Пожалуйста, следуйте этому руководству, чтобы обеспечить плавный и совместный процесс вклада.
Нажмите здесь для подробного руководства по взносу для увеличения покрытия кода.
Swagger Docs: https://api.freeapi.app
Примечание. Документы Swagger созданы автоматически из файла swagger.yaml . Запустив проект локально, убедитесь, что вы измените URL на http://localhost:<port_from_.env>/api/v1 в servers/url -сервера Swagger.
