New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review the Stripe API for comparison #12

Closed

waldoj opened this issue Apr 16, 2012 · 1 comment

Labels

API

Milestone

Member

waldoj commented Apr 16, 2012

For both documentation and clarity of thought in construction, it's an API to emulate. It's here.

Member Author

waldoj commented Dec 27, 2012

Takeaways:

Provide examples of real, full API responses in all provided formats (JSON, XML, PHP?) following an example of a real request.
Employ a layout that is conducive to providing detailed descriptions of everything that needs a detailed description.
Use complete sentences to explain plainly what each method does, even in the titles.

waldoj mentioned this issue

Document the API #15

Closed

2 tasks

waldoj closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment