A JSON API for SwiftDoc.org
The API can be found at http://api.swiftdoc.org/. Please note that this API is looking for contributors and is not under active development at this time.
This API is a Node.js Heroku application. With npm
and the Heroku command line tools installed, you can install and run this API locally with the following commands:
git clone https://github.com/SwiftDocOrg/api.swiftdoc.org.git
cd api.swiftdoc.org
npm install
heroku local
This project welcomes contributors! The API is not currently under development, so if you would like to work on it, please reach out.
Issues and pull requests should be filed in this repository for problems relating to the API itself.
For errors in the data visible through the API, please see the parser's repository, or for errors in the SwiftDoc.org site itself, see the site's repository instead.
Follow @SwiftDocOrg on Twitter.
All code is available under the MIT License. Autogenerated documentation is © 2015 Apple, Inc. All other content is released under the Creative Commons BY-NC License.