2

I have Uploaded a simple REST API java project in github. How can I call the API via url in GitHub to see if the API is working? I have read some documents about curl, but I am not sure how to use it.

 https://api.github.com/repos/github_user_name/project_name/getUser?id=100
Abdollah
  • 4,579
  • 3
  • 29
  • 49
soccerway
  • 10,371
  • 19
  • 67
  • 132
  • I don't think the GitHub API works that way. By using the GitHub API, you're not interacting with your own code. Your code isn't actually running. The API exists for getting data such as your GitHub username, project name, etc... none of your code is running. – Blaine Lafreniere Sep 29 '19 at 04:05
  • I have addressed your question "Can we use Gitlab for achieving the result ?" in my edited answer. – VonC Sep 29 '19 at 04:27

2 Answers2

2

You should not be able to cal your own API using a GitHub URL.

You cannot execute any custom process on the server (GitHub) side, except GitHub actions (like those ones).

You can use for instance Netlify to test your API from your GitHub project.

Can we use Gitlab for achieving the result ?

No: GitHub or GitLab are for hosting repositories, not for serving any custom services from those repositories (beside GitHub Pages or GitLab Pages, for publishing static websites directly from a repository)

Again, for exposing a REST API, you need a third party server.

VonC
  • 1,262,500
  • 529
  • 4,410
  • 5,250
1

GitHub only serves static web pages and does not provide any way to host a server. Your Spring Boot app is essentially a server so it is not possible to check the API through GitHub as you are intending. There are some free solutions out there like Heroku which you can use for testing purposes.

Related: How to publish a website made by Node.js to Github Pages?

Sayak Mukhopadhyay
  • 1,332
  • 2
  • 19
  • 34