README.md

Fake_APIs

Custom REST APIs for various development and testing purposes.

This repository is for anyone around the globe who wants to start creating their own REST API, for their own development, or for helping create an aggregate of unrelated data . The purpose of this repository is to learn and share knowledge.

Prerequisite

Git & Github

Here, we have mentioned the instructions to set up git. If you don't already know what Git is, check out this blog series on iRead.

• Login / Sign-up to Github.
• Download and install Git.
• Configure git
  • Launch terminal or command promt.
  • Run the commands.
    • git config --global user.name "Your name"
    • git config --global user.email "Your email address"
• Optionally, you can setup ssh keys to authenticate easily.

What to Contribute

You are free to select any topic such as Dogs, Cats, Projects, Cars, Foods etc. Your contribution must be information in JSON format about your selected topic. Just make sure to follow the below guidelines strictly.

How to contribute?

Refer to Contributing Guidelines to learn how to setup the repository.

Once you are ready with the setup, follow the below guidelines:

1. Create a file inside this project repository with the Topic Name in snake case, i.e., if your topic is Car Details, the file name should be car_details.json.
2. The file should be in the following format :

{
    "DUMMY_DATA_INFO": [
        {
            "id": 1,
            "info1": "DUMMY_DATA1",
            "info2": "DUMMY_DATA2",
            "info3": "DUMMY_LINK3",
            "info4": "DUMMY_DATA4",
        },
        {
            "id": 2,
            "info_1": "1_DUMMY_DATA1",
            "info_2": "2_DUMMY_DATA2",
            "info_3": "3_DUMMY_LINK3",
            "info_4": "4_DUMMY_DATA4",
        },
    ]
}

3. After creating the file and adding the necessary data in JSON format, stage and commit the changes.
4. Finally, push the changes and create a pull request.

---

Contributors