Giter Club home page Giter Club logo

namefy-api's Introduction

Namefy API

A API Namefy é uma aplicação TypeScript construída com Express que gera nomes aleatórios e fornece endpoints para acessar esses nomes.


Pré-requisitos

Certifique-se de que você tenha as seguintes ferramentas instaladas em sua máquina:

Instalação

Siga os passos abaixo para configurar e executar a API Namefy:

  1. Clone este repositório:
git clone https://github.com/userkbite/namefy-api.git
  1. Navegue até o diretório do projeto:
cd namefy-api
  1. Instale as dependências usando Yarn:
yarn install
  1. Inicie a API:
yarn start
  1. A API estará disponível em http://localhost:3000.

Uso

A API Namefy oferece os seguintes endpoints:

1. /api/users (GET)

Este endpoint retorna todos os dados do arquivo **data.json**, que contém os nomes gerados.

Exemplo de solicitação usando curl:

curl http://localhost:3000/api/users

2. /api/random (GET)

Este endpoint gera um nome completo aleatório (full_name), composto por um nome, sobrenome e último nome.

Exemplo de solicitação usando curl:

curl http://localhost:3000/api/random

Exemplo de resposta:

{
  "full_name": "André Pereira Cardoso"
}

Consumindo a API em Python

Aqui está um exemplo de como consumir a API Namefy em Python usando a biblioteca requests:

import requests

# Endpoint para obter um nome aleatório
random_name_url = "http://localhost:3000/api/random"

# Endpoint para obter todos os dados
all_names_url = "http://localhost:3000/api/users"

# Fazendo uma solicitação para obter um nome aleatório
response = requests.get(random_name_url)

if response.status_code == 200:
    data = response.json()
    full_name = data["full_name"]
    print(f"Nome Aleatório: {full_name}")
else:
    print("Erro ao obter um nome aleatório")

# Fazendo uma solicitação para obter todos os nomes
response = requests.get(all_names_url)

if response.status_code == 200:
    data = response.json()
    print("Todos os Nomes:")
    for i in data["users"]:
        print(i)
else:
    print("Erro ao obter todos os nomes")

Certifique-se de instalar a biblioteca requests no seu ambiente Python antes de executar o código:

pip install requests

Isso permitirá que você faça solicitações HTTP para a API Namefy a partir do seu código Python.


Autor

userkbite 👨‍💻


Contribuidores

namefy-api's People

Contributors

userkbite avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.