Skip to content

Commit c0cded9

Browse files
authored
Merge pull request #23 from Hsn723/master
Update documentation
2 parents d692901 + 4234f34 commit c0cded9

File tree

3 files changed

+26
-5
lines changed

3 files changed

+26
-5
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Visit the docs on [godoc.org][godoc].
3535

3636
[kintone]: https://www.kintone.com/
3737
[APIen]: https://developer.kintone.io/hc/en-us
38-
[APIja]: https://cybozudev.zendesk.com/hc/ja
38+
[APIja]: https://developer.cybozu.io/hc/ja
3939
[bsd2]: http://opensource.org/licenses/BSD-2-Clause
4040
[godoc]: http://godoc.org/github.com/kintone/go-kintone
4141

app.go

+24-3
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,19 @@ func (f UpdateKey) MarshalJSON() ([]byte, error) {
7272
// App provides kintone application API client.
7373
//
7474
// You need to provide Domain, User, Password, and AppId.
75-
// You can also use the api token instead of user/password.
76-
// When using Google AppEngine, you must supply Client too.
75+
// You can also use an API token instead of user/password.
76+
// If you require specialized client settings, for instance
77+
// need to specify a client certificate, proxy settings, or
78+
// are using Google AppEngine, you can build an *http.Client
79+
// instance and supply it to Client.
80+
//
81+
// ex: Google AppEngine
7782
//
7883
// import (
7984
// "appengine"
8085
// "appengine/urlfetch"
8186
// "github.com/kintone/go-kintone"
82-
// "http"
87+
// "net/http"
8388
// )
8489
//
8590
// func handler(w http.ResponseWriter, r *http.Request) {
@@ -88,6 +93,22 @@ func (f UpdateKey) MarshalJSON() ([]byte, error) {
8893
// ...
8994
// }
9095
//
96+
// ex: proxy
97+
//
98+
// import (
99+
// "net/http"
100+
// "net/url"
101+
// "github.com/kintone/go-kintone"
102+
// )
103+
//
104+
// func main() {
105+
// proxyURL, _ := url.Parse("https://proxy.example.com")
106+
// transport := &http.Transport{Proxy: http.ProxyURL(proxyURL)}
107+
// client := &http.Client(Transport: transport)
108+
// app := &kintone.App{Client: client}
109+
// ...
110+
// }
111+
//
91112
// Errors returned by the methods of App may be one of *AppError,
92113
// ErrTimeout, ErrInvalidResponse, or ErrTooMany.
93114
type App struct {

doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
Package kintone provides interfaces for kintone REST API.
33
4-
See http://developers.kintone.com/ for API specs.
4+
See https://developer.kintone.io for API specs.
55
66
import (
77
"log"

0 commit comments

Comments
 (0)