A simple GraphQL API built with TypeScript and Express. This API provides information about IP addresses, leveraging the IPAPI service.
Clone the repository:
git clone https://github.com/lvnhmd/the-graphql-server.git
Navigate to the project directory:
cd the-graphql-server
Create a .env file based on .env.example :
cp .env.example .env
Ensure the following environment variables are set in the .env file:
ACCESS_KEY=<ipapi_access_key>
BASE_URL=http://api.ipapi.com/api
Run docker-compose up --build to start the application.
This API initially used the IP data service from ipapi.co, as per the spec. However, due to rate limiting issues, I have decided to switch to ipapi.com for more reliable and unrestricted access.
To use ipapi.com, this API requires an ipapi.com API key. You can obtain your own API key by registering here. If you need a quick start, I can provide you with my API key. Just drop an email to ali.elvin@gmail.com to request it.
You can access the GraphQL API and the GraphiQL interface at http://localhost:4000 when the application is running.
- Query IP information:
query {
getIpInfo(ip: "8.8.8.8") {
ip
type
continent_code
continent_name
country_code
country_name
region_code
region_name
city
zip
latitude
longitude
location {
geoname_id
capital
languages {
code
name
native
}
country_flag
country_flag_emoji
country_flag_emoji_unicode
calling_code
is_eu
}
region_plus_code
}
}
- Query information for multiple IPs:
query {
getIpListInfo(ips: "8.8.8.8,9.9.9.9") {
ip
type
continent_code
continent_name
country_code
country_name
region_code
region_name
city
zip
latitude
longitude
location {
geoname_id
capital
languages {
code
name
native
}
country_flag
country_flag_emoji
country_flag_emoji_unicode
calling_code
is_eu
}
region_plus_code
}
}
To run the tests, use the following commands:
Install dependencies:
npm install
Run tests:
npm test