Repository navigation
Designing REST API
While working on my research, I often had problems with finding the right kind of data to test my hypotheses. And almost every time, I had to end up writing a scraper in python, which would fetch data from this website, create a data set. It would take a couple of weeks and more to get all the data since I did not have any knowledge about asynchronous programs. That time ended up getting being done this rather than the actual research work. The crawlers were not as efficiently written as I can write them now. All of those problems led to the birth of this REST API. It will definitely make the life of researchers more easy in the sense that all the hard work will be done by me. They can simply create a client endpoint which will ask for data and my API will happily and readily provide it. It can also be used for other purposes like data analysis or visualisation provided the data gets its due credit to the owner and the hosting website.
Since this is the data which I currently think can be used by researchers for their data set demands. I have the following set of common operations in mind at the moment.
- GET /v1/authors: This API will return a paginated list of authors and their information. This will not require authentication of any kind since it is not doing any kind of writes to the database. Although if too many requests come from a single source, then your IP may be black-listed for some time before resuming again. There fore, Be Gentle!
- GET /v1/author/authorName: This API will return the information about the authorName which was sent in the URL path parameter. This will not require authentication, for the same reason cited above. All other limits applicable here too.
- GET /v1/authorName/location: This API will return the location of the researcher or the location mentioned in the data fetched from the above website. Similarly, getting other information about the author too will be available for the user.
Made with love and sincere effort. If you liked the initiative, do star the project or suggest changes, if any that you want.