sgtodo-apiclient
apiclient
API Client for Interacting with Spider-Gazelle To-do API
Installation
Clone this repository into your directory and require "__dirname/src/apiclient.cr"
Usage
All methods are stored under module Apiclient. All methods are referenced in src/apiclient.cr.
WebMocks are enabled by default in specs. To turn them off to test the live API, please follow instructions to comment and uncomment code detailed in spec/*
Methods
Spider-gazelle To-do API Client supports a single stream and re-uses HTTP connection. To open a stream, simply call client = Apiclient.open
, the client variable is loaded as the first argument for all Apiclient
module methods. The methods are listed as below:
-
Get this list of all tasks
Apiclient.index(client)
-
Find a single task
Apiclient.show(client, :id)
-
Create a task
Apiclient.create(client, :body)
-
Update a task
Apiclient.update(client, :id, :body)
-
Destroy a task
Apiclient.destroy(client, :id)
-
Destroy all tasks
Apiclient.destroy_all(client)
When all operations are finished, simply call client.close
to close the stream
Params
- Request object
id: String
body: {title : String, order : Int32?, completed : Bool}
- Response object
struct ObjectReponse
include JSON::Serializable
getter id : Int32
getter title : String
getter order : Int32?
getter completed : Bool
getter url : String
end
Contributing
- Fork it (https://github.com/your-github-user/apiclient/fork)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Contributors
- Duke Nguyen - creator and maintainer
sgtodo-apiclient
- 1
- 0
- 0
- 0
- 2
- about 4 years ago
- August 20, 2020
MIT License
Thu, 07 Nov 2024 21:56:38 GMT