Introduction to Github APIs
Github APIs are a way to interact with Github. Here, we will learn about some basic things we can do with Github APIs.
Introduction to Github APIs
What are APIs
API stands for Application Program Interfaces, which developers use to access web tools or information on the cloud. It allows different cross-platform applications to talk to each other. One of the common examples of it is Google Speech to Text API used when you talk to Google Assistant.
What is Github APIs
Github APIs( or Github ReST APIs) are the APIs that you can use to interact with GitHub. They allow you to create and manage repositories, branches, issues, pull requests, and many more. For fetching publicly available information (like public repositories, user profiles, etc.), you can call the API. For other actions, you need to provide an authenticated token.
Basic Github APIs Examples
The base URL for GitHub APIs is:- GithubAPI
Accessing Public Information
Fetching user information with its username
Request type: GET API endpoint: /users/{username}
Example :-
As you can see, API returns us a JSON response with info about the user, like its image_url, name, mail_address.
Fetching user's followers' list
Request type: GET API endpoint: /users/{username}/followers
Example :-
This URL returns info about all the users that follow a particular user.
Check if a user follows another
Request type: GET API endpoint: /user/{username}/following/{target_username}
This endpoint doesn't return any content. It just returns a status code.
A status code of 204 means the is followed by the user, whereas a status code of 404 means the user does not follow a .
Example :-
When a user follows another user
When a user doesn't follow another user
Performing tasks as an authenticated user
If you provide an authenticated token, you don't need to provide a username in the endpoints mentioned above.
By providing the token, you can create repositories/gists, comment on pull requests/issues, and all other tasks that you can perform from the Web Interface.
Generating Token
You can get a token by going to Personal access tokens and clicking on Generate new token. You will be asked for the permissions/scopes of that token. Choose them wisely while creating one as some of these might be destructive.
After selecting scopes, click on generate token and save the token somewhere as you will not see that token again.
Note:- Store your token in a secured environment while using it.
Creating a Repository
Request type: POST API endpoint: /user/{repos} Required data: name
Example :-
List issues assigned to you
Request type: GET API endpoint: /issues
Example :-
Creating an issue
Request type: POST API endpoint: /repos/{owner}/{repo_name}/issues Required data: title
Example :-
Commenting on issue
Request type: POST API endpoint: /repos/{owner}/{repo_name}/issues/{issue_no}/comments Required data: body
Example :-
Note - The same endpoint is used for commenting on pull requests too. Just change the issue number with the pull request number.
Opening/Closing an issue
Request type: PUT API endpoint: /repos/{owner}/{repo_name}/issues/{issue_no}
Example :-
Note - The same endpoint is valid for updating pull requests too.
Results
The above results can be verified on the GitHub website too.
Conclusion
There are a lot more endpoints that you can explore at Github. Also, you can only do the work you are authorized to with that token. Although there are plenty of data fields that can be sent with these endpoints, only required ones are shown above.
