apihub
v1.3.0
Estamos tentando criar um único hub de API de origem que possa ser usado para aprender o manuseio da API em qualquer linguagem de programação. Os usuários podem criar seu portfólio de front -end em aplicativos da Web e móveis usando este hub de API.
O Projeto Freeapi é uma iniciativa inovadora e orientada pela comunidade, com o objetivo de fornecer aos desenvolvedores APIs gratuitas e acessíveis para seus projetos.
O projeto concentra -se em fornecer uma ampla gama de APIs que atendem a vários domínios e funcionalidades, permitindo que os desenvolvedores integrem essas APIs perfeitamente em suas aplicações.
Os principais destaques do projeto freeapi incluem:
Acessibilidade: O projeto Freeapi está comprometido em eliminar barreiras, fornecendo acesso livre à sua coleção de APIs. Os desenvolvedores podem aproveitar essas APIs sem limitações de custos, permitindo que eles experimentem, aprendam e criem aplicativos inovadores.
Coleção diversificada de API: o projeto oferece uma coleção diversificada e abrangente de APIs que abrangem diferentes setores, domínios e funcionalidades. Quer você precise de integrações de mídia social, gateways de pagamento, algoritmos de aprendizado de máquina ou conectividade do dispositivo IoT, o projeto FREEAPI o abordou.
Integração simplificada: o projeto Freeapi entende que os desafios que os desenvolvedores enfrentam ao integrar APIs em seus aplicativos. Para resolver isso, o projeto fornece documentação clara, amostras de código e SDKs, simplificando o processo de integração e reduzindo o tempo e o esforço de desenvolvimento.
Desenvolvimento orientado à comunidade: o projeto promove uma comunidade vibrante e colaborativa de desenvolvedores. Os colaboradores são incentivados a compartilhar seus conhecimentos, se envolver em discussões e colaborar em projetos relacionados à API. Esse esforço coletivo garante a melhoria contínua e a confiabilidade das APIs oferecidas pelo projeto Freeapi.
Aprendizagem e desenvolvimento de habilidades: o projeto Freeapi visa capacitar os desenvolvedores, fornecendo uma plataforma para aprendizado e desenvolvimento de habilidades. Por meio do acesso a várias APIs e recursos educacionais, os desenvolvedores podem melhorar sua compreensão da integração da API, expandir seus conhecimentos e mostrar seus conhecimentos através da construção de projetos completos.
No geral, o projeto Freeapi é um recurso valioso para os desenvolvedores que buscam APIs acessíveis e diversas.
Ao promover uma comunidade de apoio, o projeto capacita os desenvolvedores a aprender, criar e inovar, contribuindo finalmente para o crescimento e o avanço do cenário de integração da API.
Apresentando nosso inovador projeto de hub de API de código aberto, uma plataforma dinâmica projetada para revolucionar a maneira como os desenvolvedores interagem com as APIs.
Com ênfase na abertura, acessibilidade e aprendizado, nosso hub de API capacita desenvolvedores de todos os níveis para explorar, experimentar e aumentar suas habilidades na integração da API.
Destaques:
Código aberto: Nosso hub de API é construído sobre os princípios de código aberto, garantindo transparência, colaboração e desenvolvimento orientado à comunidade. Isso significa que o código -fonte está disponível gratuitamente, permitindo que os desenvolvedores personalizem, estendam e contribuam para o projeto.
Livre para usar: acreditamos firmemente na remoção de barreiras à entrada, e é por isso que nosso hub de API é totalmente livre para usar. Seja você um desenvolvedor experiente ou apenas iniciando sua jornada de codificação, pode aproveitar nossa plataforma sem limitações de custos.
Local ou implantação : a flexibilidade está no centro do nosso hub de API. Você tem a opção de usá -lo localmente, executando em sua própria máquina ou implantá -la em um servidor, tornando -o acessível a outras pessoas. Essa versatilidade garante que você possa adaptar a plataforma ao seu ambiente de desenvolvimento específico.
Recurso de Aprendizagem : Nosso Hub da API foi projetado como um recurso abrangente de aprendizado, oferecendo uma riqueza de materiais educacionais, tutoriais e documentação. Seja você iniciante ou procura expandir seu conhecimento da API, nossa plataforma fornece os recursos necessários para aprender e melhorar.
Pontos de extremidade personalizados para iniciantes : Para os desenvolvedores no nível iniciante, nosso hub de API oferece pontos de extremidade personalizados que fornecem uma experiência prática no manuseio de respostas da API. Essas APIs para iniciantes permitem que você pratique e se familiarize com o básico de trabalhar com APIs.
APIs avançadas para construção de portfólio : Além de terminais em nível iniciante, nosso Hub de API também fornece APIs avançadas para desafiar e ampliar suas habilidades. Essas APIs permitem lidar com cenários de integração mais complexos, ajudando você a criar um portfólio de projetos robustos para mostrar sua experiência.
Ao combinar princípios de código aberto, acessibilidade e foco no aprendizado, nosso projeto de hub de API abre o caminho para os desenvolvedores prosperarem no mundo da integração da API. Junte -se à nossa comunidade vibrante e embarque em uma emocionante jornada de descoberta, crescimento e inovação.
Nosso projeto de código aberto está atualmente hospedado em um servidor remoto, onde somos forçados a redefinir todo o servidor, incluindo o sistema de arquivos e o banco de dados MongoDB , a cada 2 horas para evitar incorrer em custos adicionais.
Esse processo resulta na exclusão de todos os arquivos de imagem/estática e uma redefinição de todo o banco de dados no servidor.
Perda de dados: quaisquer alterações feitas durante o intervalo de duas horas (no servidor remoto), incluindo imagens e dados do usuário carregados, serão perdidos e irrecuperáveis.
Interrupção de serviço: a redefinição do servidor pode interromper seus processos de desenvolvimento e teste por uma certa duração enquanto o servidor está reiniciando (por 1-2 minutos).
Uso local da API: para fins de desenvolvimento e teste, recomendamos fortemente o uso da API localmente em sua máquina clonando o projeto .
Isso garante que seu trabalho não seja afetado pelo servidor redefine e permita que você mantenha um ambiente de desenvolvimento estável em sua máquina local.
Auto-hospedagem na ferrovia (recomendada para projetos pessoais) : Para se auto-hospedar o aplicativo FREEAPI.APP, você pode aproveitar um modelo pré-criado que está prontamente disponível. Clique aqui para documentos detalhados
Para executar o projeto freeapi, siga estas etapas:
.env na pasta root e copie o conteúdo do .env.sample e adicione as credenciais necessárias.docker-compose up --build --attach backend
# --build: Rebuild the image and run the containers
# --attach: only show logs of Node app container and not mongodbPara executar o projeto freeapi localmente, siga estas etapas:
.env na pasta root e copie o conteúdo do .env.sample e adicione as credenciais necessárias.yarn installyarn startPara se auto-hospedar o aplicativo FREEAPI.APP, você pode aproveitar um modelo pré-criado que está prontamente disponível.
Clique no botão acima para visitar a Railway.App.
Clique no botão Implantar agora .
(Opcional) Faça login com o GitHub para implantar.
Preencha os detalhes do repositório:
Para variáveis ambientais, fornecemos alguns valores padrão no ENV para reduzir a carga, mas alguns parâmetros são obrigatórios:
PORT : Não altere o valor, deixe -o definir como 8080 para visualizar os documentos Swagger após a implantação.MONGODB_URI : Forneça o URL do banco de dados do MongoDB ATLAS. Um exemplo é preenchido para você, edite/atualize -o para continuar.NODE_ENV : padrão definido como 'desenvolvimento' para visualizar os logs. Você pode optar por alterá -lo para 'produção' (adicione exatamente a mesma palavra) para escondê -los.EXPRESS_SESSION_SECRET : É recomendável alterar o valor padrão para seu próprio valor secreto.ACCESS_TOKEN_SECRET : É recomendável alterar o valor padrão para seu próprio valor secreto.ACCESS_TOKEN_EXPIRY : definido como 1 dia como padrão.REFRESH_TOKEN_SECRET : é aconselhável alterar o valor padrão para seu próprio valor secreto.REFRESH_TOKEN_EXPIRY : definido como 10 dias como padrão.FREEAPI_HOST_URL : defina -o como URL ferroviário gerado.Depois de preencher os parâmetros de ambiente necessários, se você optar por adicionar outras pessoas como PayPal, Google e Razorpay, prossiga mencionar suas credenciais no formulário.
Clique no botão de implantação para acionar a primeira compilação.
Nota: Depois que o aplicativo for implantado, aguarde 3-5 minutos para que os documentos de arrogância estejam disponíveis.
Para garantir confiabilidade e estabilidade para nossos usuários finais, utilizamos dramaturgos, uma poderosa estrutura de teste para automatizar os testes em todos os pontos de extremidade.
Certifique -se de adicionar MONGO_MEMORY_SERVER_PORT=10000 (porta MongoDB para teste E2E) no seu arquivo .env .
yarn start:test-serveryarn test:playwrightIsso gerará um relatório de dramaturgo. Para visualizar este relatório, execute o seguinte comando
yarn playwright show-reportVerifique se todos os casos de teste são passados sempre que você fizer alterações.
Congratulamo -nos com seu interesse em contribuir para o nosso projeto de código aberto!
Para contribuir com Freeapi, siga estas etapas:
git checkout -b feat/your-feature-name ou git checkout -b fix/your-bug-fix-name e faça suas alterações.git commit -am 'add your commit message'git push origin feat/your-feature-name .Aqui está um guia sobre como você pode contribuir efetivamente para o nosso hub de API:
Puxe solicitações de atualizações de leitura: evite enviar solicitações de puxar apenas para atualizar o arquivo ReadMe do projeto. Embora apreciemos a importância de documentação clara e concisa, preferimos focar em contribuições substanciais de código e aprimoramentos de recursos.
Atualizações gramaticais: nossa equipe valoriza a comunicação eficaz, mas não somos atrevadores de gramática. Você não precisa enviar solicitações de puxar apenas para correções gramaticais ou pequenas melhorias no idioma. Em vez disso, concentre -se nas funcionalidades e recursos do projeto.
Evite atualizar as APIs públicas existentes: para manter a estabilidade e a consistência, desencorajamos atualizações diretas às APIs públicas existentes no hub da API. Essas APIs foram completamente testadas e aprovadas. No entanto, se você encontrar bugs ou problemas, incentivamos você a abrir um problema no rastreador de problemas do nosso projeto para nos notificar.
Construa novas APIs de projeto: incentivamos você a explorar sua criatividade e contribuir com a criação de APIs completas do projeto. Essas APIs devem fornecer soluções abrangentes que possam ajudar os desenvolvedores a construir projetos complexos para mostrar suas habilidades e habilidades. Suas contribuições nessa área beneficiarão muito a comunidade.
Reduzir uma proposta e discutir sobre discórdia: Antes de mergulhar em seu projeto, recomendamos a elaboração de uma proposta. Isso pode incluir um mapa mental ou esboço da API que você pretende construir e seus benefícios potenciais. Junte -se à nossa comunidade Discord, onde você pode compartilhar sua proposta, discutir idéias e receber feedback de colaboradores. O envolvimento nessas discussões aprimorará seu portfólio de back -end e ajudará a moldar a direção futura do projeto.
Agradecemos seu entusiasmo e esperamos suas valiosas contribuições para o nosso projeto de hub de API de código aberto.
Juntos, podemos promover um ambiente colaborativo e causar um impacto significativo no cenário da integração da API.
Clique aqui para o guia de contribuição detalhado.
Obrigado pelo seu interesse em contribuir para o projeto FREEAPI, criando aplicativos de front -end que consomem freeapis! Seus esforços desempenham um papel crucial no aprimoramento da experiência do usuário e na expansão do alcance de nossas APIs. Siga este guia para garantir um processo de contribuição suave e colaborativa.
Clique aqui para obter um guia de contribuição detalhado para desenvolvedores de front -end!
Obrigado pelo seu interesse em contribuir para o projeto Freeapi para aumentar a cobertura do código do nosso serviço de API, que nos ajuda a enviar pontos de extremidade robustos que são testados no campo de batalha. Siga este guia para garantir um processo de contribuição suave e colaborativa.
Clique aqui para obter um guia de contribuição detalhado para aumentar a cobertura do código.
Swagger Docs: https://api.freeapi.app
NOTA: Os documentos de swagger são gerados automaticamente a partir do arquivo swagger.yaml . Ao executar o projeto localmente, altere o URL para http://localhost:<port_from_.env>/api/v1 no campo Swagger Docs servers/url .
