Skip to content

Commit a9df9aa

Browse files
committed
Added content into README.md file
1 parent 73b30d5 commit a9df9aa

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
11
# NAPI
2-
An API in process
2+
An API which gives data on all Nobel laureates.
3+
4+
This API's source data is taken from public dataset [here](https://github.com/jdorfman/awesome-json-datasets#nobel-prize).
5+
6+
## What is different here :
7+
This API do not have any database, and uses an external **JSON** file.
8+
The API structures and provides various queries using client-side SQL like module called [alasql](https://www.npmjs.com/package/alasql).
9+
10+
## Routes :
11+
Users can access the list of routes mentioned below to get JSON data.
12+
13+
+ **HOME ROUTE :**
14+
This route is the home route of the API. This route can be accessed by `https://nobelapi.herokuapp.com/`
15+
16+
+ **NAME :**
17+
This route gives the Nobel laureates data based on their name.
18+
To access this route,
19+
`https://nobelapi.herokuapp.com/name/{name_of_laureate}`
20+
21+
+ **BORNAT :**
22+
This route gives a list of laureates for the given born country code.This route can be accessed by `https://nobelapi.herokuapp.com/bornat/{Country_Code}`
23+
24+
+ **DIEDAT :**
25+
This route gives a list of laureates for the given died country code.This route can be accessed using `https://nobelapi.herokuapp.com/diedat/{Country_Code}`
26+
27+
+ **GENDER :**
28+
This gives a list of laureates for a given gender.This can be accessed using `https://nobelapi.herokuapp.com/gender/{GENDER}`. The parameter {GENDER} should be a `male` or `female` in Lowercase.
29+
30+
+ **GENDER AND BORN COUNTRY :**
31+
This gives a list of laureates for a given gender born at given country. This can be accessed using `https://nobelapi.herokuapp.com/{GENDER}/{Country_Code}`. Here `{Country_Code}`denotes the **born country**.
32+
33+
+ **BORNAT AND DIEDAT :**
34+
This gives a a list of laureates based on their born country and died country. One can combine parameters to get desired results using this route. This route can be accessed by `https://nobelapi.herokuapp.com/bornat/{Country_Code_1}/diedat/{Country_code_2}`. Here `Country_Code_1` denotes **born country** and `Country_Code_2` denotes **died country**.
35+
36+
## Something's not right ?
37+
Please open an issue, I'll be happy to look into it.
38+
39+
## Need some more ?
40+
Please open an issue again, clearly stating, what feautre you would like to add. We'll make it better.
41+
42+
## License:
43+
```
44+
MIT License
45+
46+
Copyright (c) 2021 Vishwa.R
47+
48+
```

0 commit comments

Comments
 (0)