Additional API documentation

[di]

Our API Reference page does not have any documentation for our current JSON APIs:

• https://pypi.org/pypi/<project_name>/json
• https://pypi.org/pypi/<project_name>/<version>/json

Some discussion about what the different endpoints could be used for would be great as well. For example, the projects endpoint lists all releases for a project, and the release endpoint includes all the files as well as MD5 and SHA256 hashes.

---

Good First Issue: This issue is good for first time contributors. If there is not a corresponding pull request for this issue, it is up for grabs. For directions for getting set up, see our Getting Started Guide. If you are working on this issue and have questions, please feel free to ask them here, #pypa-dev on Freenode, or the pypa-dev mailing list.

[brainwane]

In our meeting today we discussed this issue. We have a read-only API for programmatic access, and many people want to integrate their tools with our API, so we decided this issue belongs in milestone 3 (in the next few months), in which we publicize the Warehouse beta.

Also I'm going to break this out into some sub-issues to make it easier to get the minimum done right away (perhaps just example usage like in #1721 plus a little about neighborly usage and rate limits), then add more detail to our API docs later.

[brainwane]

Sub-issues:

• Explain/expand list of current API endpoints/feeds #2930 Explain/expand list of current API endpoints/feeds
• Add architecture explanation to application structure overview #2794 (comment) Explain, in application architecture overview, what parts of the application produce the APIs
• Document API policies #2931 Document API policies
• Add API explorer tool #2929 Add API explorer tool