search

puppetlabs / clj-http-client

HTTP client library wrapping Apache HttpAsyncClient
Apache License 2.0
15 stars 30 forks source link

(TK-117) Add external API docs #28

Closed MSLilah closed 9 years ago

MSLilah commented 9 years ago

Add some external API docs in the doc folder which detail how to make requests using the Java and clojure clients.

camlow325 commented 9 years ago

This isn't specifically covered in the ticket but I think to make the documentation a little easier to consume, it might help to include some source code examples which show how to make each of the requests. Could just be a single example per major type - e.g., Clojure persistent client Sync, Clojure persistent client Async, Clojure single request Sync, Java persistent client Sync, Java persistent client Async, Java single request Sync. If you think this adds to much to the intention of this PR, though, I'd be open to having that done in a new ticket.

camlow325 commented 9 years ago

:+1: with some minor comments and questions on Javadocs / source code examples.

MSLilah commented 9 years ago

Okay, @camlow325 I've addressed all of your comments. Also @camlow325 @nwolfe I've added Javadoc strings to all the user-facing Java classes and have modified the java-client.md file to link to the classes for documentation.

nwolfe commented 9 years ago

@fpringvaldsen Nice - this looks and reads way better!

camlow325 commented 9 years ago

:+1: with a number of cosmetic comments littered throughout. This is looking really good!

MSLilah commented 9 years ago

@camlow325 I believe I've addressed all your comments.

camlow325 commented 9 years ago

:+1: @nfagerlund, you may want to take a look at these docs at some point.