|
1 | 1 | --- |
2 | | -title: GitHub API |
| 2 | +title: GitHub Developer |
| 3 | +layout: overview |
3 | 4 | --- |
4 | 5 |
|
5 | | -# The GitHub API |
| 6 | +<div class="wrapper feature"> |
| 7 | + <h1>Leverage the power of<br /> |
| 8 | +GitHub in your app</h1> |
| 9 | + <p class="intro">Get started with one of our guides, or jump straight into the API documentation.</p> |
| 10 | + <a href="/v3/" class="button">Browse the documentation</a> |
| 11 | + <img src="/shared/images/labtocat.png" class="labtocat" /> |
| 12 | +</div> |
| 13 | + |
| 14 | +<div class="full-width-divider"> |
| 15 | + <ul class="wrapper highlights"> |
| 16 | + <li> |
| 17 | + <h2>Get Started</h2> |
| 18 | + <p>New to the GitHub API? With these guides you’ll be up and running in a snap.</p> |
| 19 | + <a href="/guides/" class="button-secondary">View introduction guides</a> |
| 20 | + <img class="octocat professorcat" src="/shared/images/professorcat.png"> |
| 21 | + </li> |
| 22 | + <li> |
| 23 | + <h2>Libraries</h2> |
| 24 | + <p>We’ve got you covered. Use the GitHub API in your favorite language.</p> |
| 25 | + <a href="/libraries/" class="button-secondary">Browse libraries</a> |
| 26 | + <img class="octocat" src="/shared/images/gundamcat-small.png"> |
| 27 | + </li> |
| 28 | + <li> |
| 29 | + <h2>Support</h2> |
| 30 | + <p>Are you stuck? Already tried our <a href="/v3/troubleshooting/">troubleshooting guide</a>? Talk to a supportocat.</p> |
| 31 | + <a href="http://github.com/contact" class="button-secondary">Get in touch</a> |
| 32 | + <img class="octocat" src="/shared/images/supportocat.png"> |
| 33 | + </li> |
| 34 | + |
| 35 | + </ul> |
| 36 | +</div> |
6 | 37 |
|
7 | | -This describes the resources that make up the official GitHub API v3. If |
8 | | -you have any problems or requests please contact |
9 | | -[support](https://github.com/contact?form[subject]=APIv3). |
10 | | - |
11 | | -For the new API v3, start browsing the resources on the right >> |
12 | | - |
13 | | -View the [API Changelog](/changes) for information on existing and |
14 | | -planned changes to the API. |
15 | | - |
16 | | -## Current Version |
17 | | - |
18 | | - Accept: application/vnd.github.beta+json |
19 | | - |
20 | | -The GitHub API version is currently in beta. [The `beta` media type](/v3/media/) |
21 | | -property will be valid until sometime in 2013. A notice will be given closer |
22 | | -to the actual date. |
23 | | - |
24 | | -We consider the "beta" API unchangeable. [File a support issue](https://github.com/contact) |
25 | | -if you have problems. |
26 | | - |
27 | | -### Deprecations |
28 | | - |
29 | | -The following functionality is deprecated. For backwards compatibility purposes, |
30 | | -API v3 will continue to provide this functionality. However, this deprecated |
31 | | -functionality **will be removed** in the _next_ major version of the API. |
32 | | - |
33 | | -The recommendations below will help you prepare your application for the next major version of the API. |
34 | | - |
35 | | -1. Method: /gists/:id/fork |
36 | | -: Recommendation: Use **/gists/:id/forks** (plural) instead. |
37 | | - |
38 | | -1. Method: /legacy/issues/search/:owner/:repository/:state/:keyword |
39 | | -: Recommendation: Use [v3 Issue Search API](v3/search/#search-issues) instead. |
40 | | - |
41 | | -1. Method: /legacy/repos/search/:keyword |
42 | | -: Recommendation: Use [v3 Repository Search API](/v3/search/#search-repositories) instead. |
43 | | - |
44 | | -1. Method: /legacy/user/search/:keyword |
45 | | -: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead. |
46 | | - |
47 | | -1. Method: /legacy/user/email/:email |
48 | | -: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead. |
49 | | - |
50 | | -1. Method: /repos/:owner/:repo/hooks/:id/test |
51 | | -: Recommendation: Use **/repos/:owner/:repo/hooks/:id/tests** (plural) instead. |
52 | | - |
53 | | -1. Query parameters when POSTing to /repos/:owner/:repo/forks |
54 | | -: Recommendation: Use JSON to POST to this method instead. |
55 | | - |
56 | | -1. Pull Request attribute: merge_commit_sha |
57 | | -: Recommendation: [Do not use this attribute](/changes/2013-04-25-deprecating-merge-commit-sha/). |
58 | | - |
59 | | -1. Rate Limit attribute: rate |
60 | | -: Recommendation: Use **resources["core"]** instead. |
61 | | - |
62 | | -1. Repository attribute: forks |
63 | | -: Recommendation: Use **fork_count** instead. |
64 | | - |
65 | | -1. Repository attribute: master_branch |
66 | | -: Recommendation: Use **default_branch** instead. |
67 | | - |
68 | | -1. Repository attribute: open_issues |
69 | | -: Recommendation: Use **open_issues_count** instead. |
70 | | - |
71 | | -1. Repository attribute: public |
72 | | -: Recommendation: When [creating a repository](/v3/repos/#create), use the |
73 | | - **private** attribute to indicate whether the repository should be public or |
74 | | - private. Do not use the **public** attribute. |
75 | | - |
76 | | -1. Repository attribute: watchers |
77 | | -: Recommendation: Use **watchers_count** instead. |
78 | | - |
79 | | -1. User attribute: bio |
80 | | -: Recommendation: Do not use this attribute. It is obsolete. |
81 | | - |
82 | | -### Breaking Beta Changes |
83 | | - |
84 | | -##### June 12, 2012: |
85 | | -* Removed API v1 support |
86 | | -* Removed API v2 support |
87 | | - |
88 | | -##### June 15th, 2011: |
89 | | - |
90 | | -* `gravatar_url` is being deprecated in favor of `avatar_url` for all |
91 | | - responses that include users or orgs. A default size is no longer |
92 | | - included in the URL. |
93 | | -* Creating new gists (both anonymously and with an authenticated user) |
94 | | - should use `POST /gists` from now on. `POST /users/:user/gists` is no |
95 | | - longer supported. |
96 | | - |
97 | | -##### June 1st, 2011: |
98 | | - |
99 | | -* Removed support for PUT verb on update requests. Use POST or PATCH |
100 | | - instead. |
101 | | -* Removed `.json` extension from all URLs. |
102 | | -* No longer using the X-Next or X-Last headers. Pagination info is |
103 | | - returned in the Link header instead. |
104 | | -* JSON-P response has completely changed to a more consistent format. |
105 | | -* Starring gists now uses PUT verb (instead of POST) and returns 204. |
106 | | - |
107 | | -[v3-email]: /v3/users/emails/#future-response |
0 commit comments