seyi-adeleke/nigerian-states-api

An api for basic information about all 36 states in Nigeria

Introduction

This provides an unofficial API for obtaining basic information about all 36 states in Nigeria. Built with NodeJs and Mongo.

API Routes

• BASE_URL: https://nigerian-states-info.herokuapp.com

• /api/v1 - Returns information about Nigeria
• /api/v1/states - Returns information about all Nigerian states
• /api/v1/states/:name - Returns information about the specified state

Method

GET

Disclaimer

I cannot independently verify that the information in this API is 100% accurate.

nigerian-states-api's Issues

API not functional

Hi @seyi-adeleke please note that there is an issue with the API.

Please if you are using mlab for the application, please switch to mongodb Atlas as Heroku has discontinued the feature.

Hope to hear from you soon.

Best regards

Outline the kind of data each endpoint will expose in the docs

for each endpoint on the docs, we should have an object that shows the list of data the endpoint will expose when it is called. i.e
state = {
name: ""
governor: "",
landmark: ""
},
this is according to the model of DB.
then give an example with one state API call.

Hitting a route that doesn't exist should return a well formatted error message

Currently, when a user tries to access an endpoint that doesn't exist the application returns an error. A well formatted error message should be returned when such a situation occurs.