A API Namefy é uma aplicação TypeScript construída com Express que gera nomes aleatórios e fornece endpoints para acessar esses nomes.
Certifique-se de que você tenha as seguintes ferramentas instaladas em sua máquina:
Siga os passos abaixo para configurar e executar a API Namefy:
- Clone este repositório:
git clone https://github.com/userkbite/namefy-api.git
- Navegue até o diretório do projeto:
cd namefy-api
- Instale as dependências usando Yarn:
yarn install
- Inicie a API:
yarn start
- A API estará disponível em
http://localhost:3000
.
A API Namefy oferece os seguintes endpoints:
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
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"
}
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.