README
¶
jsonstore
A client for the https://www.jsonstore.io API (backend source code is available at https://github.com/bluzi/jsonstore)
Installation
go get -u github.com/peterhellberg/jsonstore
Usage example
package main
import (
"context"
"fmt"
"github.com/peterhellberg/jsonstore"
)
const secret = "3ba7860f742fc15d5b6e1508e2de1e0cde2c396f7c52a877905befb4e970eaaf"
type example struct {
Number int
Bool bool
String string
}
func main() {
ctx := context.Background()
store := jsonstore.New(jsonstore.Secret(secret))
store.Post(ctx, "key", example{1234, true, "initial"})
store.Put(ctx, "key/String", "modified")
store.Delete(ctx, "key/Bool")
var e example
store.Get(ctx, "key", &e)
fmt.Printf("%s -> %+v\n", store.URL("key"), e)
}
License (MIT)
Copyright (c) 2018 Peter Hellberg
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
¶
Overview ¶
Package jsonstore is a client for the https://www.jsonstore.io API
Installation
go get -u github.com/peterhellberg/jsonstore
Usage
package main
import (
"context"
"fmt"
"github.com/peterhellberg/jsonstore"
)
const secret = "3ba7860f742fc15d5b6e1508e2de1e0cde2c396f7c52a877905befb4e970eaaf"
type example struct {
Number int
Bool bool
String string
}
func main() {
ctx := context.Background()
store := jsonstore.New(jsonstore.Secret(secret))
store.Post(ctx, "key", example{1234, true, "initial"})
store.Put(ctx, "key/String", "modified")
store.Delete(ctx, "key/Bool")
var e example
store.Get(ctx, "key", &e)
fmt.Printf("%s -> %+v\n", store.URL("key"), e)
}
Index ¶
- Variables
- func NewSecret() (string, error)
- type Client
- func (c *Client) Delete(ctx context.Context, path string) error
- func (c *Client) Get(ctx context.Context, path string, v interface{}) error
- func (c *Client) Post(ctx context.Context, path string, v interface{}) error
- func (c *Client) Put(ctx context.Context, path string, v interface{}) error
- func (c *Client) Secret() string
- func (c *Client) URL(segments ...string) *url.URL
- type Option
Constants ¶
This section is empty.
Variables ¶
var ( ErrNoSecret = fmt.Errorf("no secret") ErrNotFound = fmt.Errorf("not found") ErrInternalServerError = fmt.Errorf("internal server error") ErrUnexpectedStatus = fmt.Errorf("unexpected status") )
Errors
Functions ¶
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for the www.jsonstore.io API
Source Files