Skip to content

Commit 49d853a

Browse files
jobs-freelancerjobs-freelancer
authored
Update README.md
1 parent 05bb963 commit 49d853a

File tree

1 file changed

+159
-0
lines changed

1 file changed

+159
-0
lines changed

‎README.md‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,162 @@ Caso você queira apenas baixar a imagem e executar a aplicação, basta seguir
7070
# Consumindo a aplicação com Swagger
7171
- Caso você queira apenas consumir as APIs do projeto, ele está hospedado no [Heroku](https://heroku.com).
7272
- A URL da aplicação com o Swagger é esta: `https://github-developers.herokuapp.com/swagger-ui.html`
73+
74+
## APIs do GitHub:
75+
76+
### Endpoints:
77+
- Você pode buscar por repositórios: `/search/repositories`
78+
79+
- Response padrão [exemplo]:
80+
81+
```
82+
Status: 200 OK
83+
```
84+
85+
```
86+
{
87+
"total_count": 40,
88+
"incomplete_results": false,
89+
"items": [
90+
{
91+
"id": 3081286,
92+
"node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2",
93+
"name": "Tetris",
94+
"full_name": "dtrupenn/Tetris",
95+
"owner": {
96+
"login": "dtrupenn",
97+
"id": 872147,
98+
"node_id": "MDQ6VXNlcjg3MjE0Nw==",
99+
"avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
100+
"gravatar_id": "",
101+
"url": "https://api.github.com/users/dtrupenn",
102+
"received_events_url": "https://api.github.com/users/dtrupenn/received_events",
103+
"type": "User",
104+
"html_url": "https://github.com/octocat",
105+
"followers_url": "https://api.github.com/users/octocat/followers",
106+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
107+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
108+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
109+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
110+
"organizations_url": "https://api.github.com/users/octocat/orgs",
111+
"repos_url": "https://api.github.com/users/octocat/repos",
112+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
113+
"site_admin": true
114+
},
115+
"private": false,
116+
"html_url": "https://github.com/dtrupenn/Tetris",
117+
"description": "A C implementation of Tetris using Pennsim through LC4",
118+
"fork": false,
119+
"url": "https://api.github.com/repos/dtrupenn/Tetris",
120+
"created_at": "2012-01-01T00:31:50Z",
121+
"updated_at": "2013-01-05T17:58:47Z",
122+
"pushed_at": "2012-01-01T00:37:02Z",
123+
"homepage": "https://github.com",
124+
"size": 524,
125+
"stargazers_count": 1,
126+
"watchers_count": 1,
127+
"language": "Assembly",
128+
"forks_count": 0,
129+
"open_issues_count": 0,
130+
"master_branch": "master",
131+
"default_branch": "master",
132+
"score": 1,
133+
"archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}",
134+
"assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}",
135+
"blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}",
136+
"branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}",
137+
"collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}",
138+
"comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}",
139+
"commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}",
140+
"compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}",
141+
"contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}",
142+
"contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors",
143+
"deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments",
144+
"downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads",
145+
"events_url": "https://api.github.com/repos/dtrupenn/Tetris/events",
146+
"forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks",
147+
"git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}",
148+
"git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}",
149+
"git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}",
150+
"git_url": "git:github.com/dtrupenn/Tetris.git",
151+
"issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}",
152+
"issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}",
153+
"issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}",
154+
"keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}",
155+
"labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}",
156+
"languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages",
157+
"merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges",
158+
"milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}",
159+
"notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}",
160+
"pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}",
161+
"releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}",
162+
"ssh_url": "git@github.com:dtrupenn/Tetris.git",
163+
"stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers",
164+
"statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}",
165+
"subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers",
166+
"subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription",
167+
"tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags",
168+
"teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams",
169+
"trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}",
170+
"clone_url": "https://github.com/dtrupenn/Tetris.git",
171+
"mirror_url": "git:git.example.com/dtrupenn/Tetris",
172+
"hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks",
173+
"svn_url": "https://svn.github.com/dtrupenn/Tetris",
174+
"forks": 1,
175+
"open_issues": 1,
176+
"watchers": 1,
177+
"has_issues": true,
178+
"has_projects": true,
179+
"has_pages": true,
180+
"has_wiki": true,
181+
"has_downloads": true,
182+
"archived": true,
183+
"disabled": true,
184+
"license": {
185+
"key": "mit",
186+
"name": "MIT License",
187+
"url": "https://api.github.com/licenses/mit",
188+
"spdx_id": "MIT",
189+
"node_id": "MDc6TGljZW5zZW1pdA==",
190+
"html_url": "https://api.github.com/licenses/mit"
191+
}
192+
}
193+
]
194+
}
195+
```
196+
- Você também pode buscar por usuários: `/search/users`
197+
- Response padrão [exemplo]:
198+
199+
```
200+
Status: 200 OK
201+
```
202+
203+
```
204+
{
205+
"total_count": 12,
206+
"incomplete_results": false,
207+
"items": [
208+
{
209+
"login": "mojombo",
210+
"id": 1,
211+
"node_id": "MDQ6VXNlcjE=",
212+
"avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
213+
"gravatar_id": "",
214+
"url": "https://api.github.com/users/mojombo",
215+
"html_url": "https://github.com/mojombo",
216+
"followers_url": "https://api.github.com/users/mojombo/followers",
217+
"subscriptions_url": "https://api.github.com/users/mojombo/subscriptions",
218+
"organizations_url": "https://api.github.com/users/mojombo/orgs",
219+
"repos_url": "https://api.github.com/users/mojombo/repos",
220+
"received_events_url": "https://api.github.com/users/mojombo/received_events",
221+
"type": "User",
222+
"score": 1,
223+
"following_url": "https://api.github.com/users/mojombo/following{/other_user}",
224+
"gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}",
225+
"starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}",
226+
"events_url": "https://api.github.com/users/mojombo/events{/privacy}",
227+
"site_admin": true
228+
}
229+
]
230+
}
231+
```

0 commit comments

Comments
 (0)