yubin.byb 10 年之前
父節點
當前提交
711f57a467
共有 6 個文件被更改,包括 28 次插入22 次删除
  1. 1 1
      doc/上传文件.md
  2. 9 6
      doc/下载文件.md
  3. 5 2
      doc/安装.md
  4. 1 1
      doc/快速开始.md
  5. 9 9
      doc/管理文件.md
  6. 3 3
      doc/自定义域名绑定.md

+ 1 - 1
doc/上传文件.md

@@ -2,7 +2,7 @@
 OSS Go SDK提供了丰富的文件上传接口,用户可以通过以下方式向OSS中上传文件:
 
 - 简单上传PutObject,适合小文件
-- 断点续传上传UploadFile,适合大文件
+- 分片上传UploadFile,适合大文件
 - 追加上传AppendObject
 
 ## 简单上传

+ 9 - 6
doc/下载文件.md

@@ -2,18 +2,18 @@
 
 OSS Go SDK提供了丰富的文件下载接口,用户可以通过以下方式从OSS中下载文件:
 
-- 下载到数据流io.ReadCloser
+- 下载到流io.ReadCloser
 - 下载到本地文件
 - 分片下载
 
-## 下载到数据流io.ReadCloser
+## 下载到流io.ReadCloser
 
 > 提示:
 > 
 > - 下载的示例代码在`sample/get_object.go`。
 > 
 
-### 下载文件到数据
+### 下载文件到流
 ```go
     import (
         "fmt"
@@ -48,7 +48,7 @@ OSS Go SDK提供了丰富的文件下载接口,用户可以通过以下方式
 > - io.ReadCloser数据读取完毕后,需要调用Close关闭。
 > 
 
-### 下载文件到缓存
+### 下载文件到缓存
 ```go
     import (
         "bytes"
@@ -75,7 +75,7 @@ OSS Go SDK提供了丰富的文件下载接口,用户可以通过以下方式
 	body.Close()
 ```
 
-### 下载文件到本地文件流
+### 下载文件到本地文件流
 ```go
     import (
             "io"
@@ -128,7 +128,9 @@ OSS Go SDK提供了丰富的文件下载接口,用户可以通过以下方式
     }
 ```
 
+
 ## 分片下载
+
 当下载大文件时,如果网络不稳定或者程序崩溃了,则整个下载就失败了。用户
 不得不重头再来,这样做不仅浪费资源,在网络不稳定的情况下,往往重试多次
 还是无法完成下载。
@@ -175,8 +177,9 @@ OSS Go SDK提供了丰富的文件下载接口,用户可以通过以下方式
 >   果cpt文件损坏则重新下载文件
 > - 如果下载过程中待下载的Object发生了改变(ETag改变),或者part文件丢
 >   失或被修改,则重新下载文件
+>
 
-
+>
 > 提示:
 > - 指定断点续传checkpoint文件路径使用`oss.Checkpoint(true, "your-cp-file.cp")`
 > - 使用`bucket.DownloadFile(objectKey, localFile, 100*1024)`,默认不使用分片并发下载、不启动断点续传

+ 5 - 2
doc/安装.md

@@ -1,7 +1,7 @@
 # SDK安装
 
 - github地址:https://github.com/aliyun/aliyun-oss-go-sdk
-- API文档地址:http://www.godoc.info/gems/aliyun-sdk/
+- API文档地址:https://godoc.org/github.com/aliyun/aliyun-oss-go-sdk/oss
 
 ### 要求
 
@@ -17,9 +17,11 @@
 ### 安装
 
 #### GitHub安装
+
+>
 > - 执行命令`go get github.com/aliyun/aliyun-oss-go-sdk/oss`获取远程代码包。
 > - 在您的代码中使用`import "github.com/aliyun/aliyun-oss-go-sdk/oss"`引入OSS Go SDK的包。
-> - 如果您需要查看示例程序,请到`https://github.com/aliyun/aliyun-oss-go-sdk/`下的smaple目录。
+> - 如果您需要查看示例程序,请到`https://github.com/aliyun/aliyun-oss-go-sdk/`下的sample目录。
 >
 
 > 提示:
@@ -27,6 +29,7 @@
 > - 使用`go get`命令安装过程中,界面不会打印提示,如果网络较差,需要一段时间,请耐心等待。如果安装过程中发生超时,请再次执行`go get`安装。 
 > - 安装成功后,在您的安装路径下(即GOPATH变量中的第一个路径),会有Go Sdk的库`pkg/linux_amd64/github.com/aliyun/aliyun-oss-go-sdk/oss.a`(win在`pkg\windows_amd64\github.com\aliyun\aliyun-oss-go-sdk\oss.a`),
 源文件在`src/github.com/aliyun/aliyun-oss-go-sdk`,如果没有请重新安装。
+>
 
 ### 运行sample
 

+ 1 - 1
doc/快速开始.md

@@ -1,7 +1,7 @@
 # 快速开始
 
 下面介绍如何使用OSS Go SDK来访问OSS服务,包括查看Bucket列表,查看文
-件列表,上传/下载文件和删除文件。以下操作代码您需要引入oss的包,使用`import "oss"`(源码安装)或`import github.com/aliyun/aliyun-oss-go-sdk/oss`(GitHub安装),后面的示例中全部使用`import "oss"`,不再特殊说明
+件列表,上传/下载文件和删除文件。使用OSS Go SDK,需要引入oss包`import github.com/aliyun/aliyun-oss-go-sdk/oss`
 
 ## 初始化Client
 

+ 9 - 9
doc/管理文件.md

@@ -17,7 +17,7 @@
 > - ListObjects的示例代码在`sample/list_objects.go`
 >
 
-### 使用默认参数获取存储空间的文件列表,默认返回100条Object
+### 使用默认参数获取存储空间的文件列表,默认返回100条Object
 ```go
     import "fmt"
     import "github.com/aliyun/aliyun-oss-go-sdk/oss"
@@ -40,7 +40,7 @@
     fmt.Println("Objects:", lsRes.Objects)
 ```
 
-### 指定最大返回数量,最多不能超过1000条
+### 指定最大返回数量,最多不能超过1000条
 ```go
     lsRes, err := bucket.ListObjects(oss.MaxKeys(200))
     if err != nil {
@@ -49,7 +49,7 @@
     fmt.Println("Objects:", lsRes.Objects)
 ```
 
-### 返回指定前缀的Object,默认最多返回100条
+### 返回指定前缀的Object,默认最多返回100条
 ```go
     lsRes, err := bucket.ListObjects(oss.Prefix("my-object-"))
     if err != nil {
@@ -58,7 +58,7 @@
     fmt.Println("Objects:", lsRes.Objects)
 ```
 
-### 指定从某个Object(my-object-xx)后返回,默认最多100条
+### 指定从某个Object(my-object-xx)后返回,默认最多100条
 ```go
     lsRes, err := bucket.ListObjects(oss.Marker("my-object-xx"))
     if err != nil {
@@ -67,7 +67,7 @@
     fmt.Println("Objects:", lsRes.Objects)
 ```
 
-### 分页获取所有Object,每次返回200条
+### 分页获取所有Object,每次返回200条
 ```go
     marker := oss.Marker("")
     for {
@@ -85,7 +85,7 @@
     }
 ```
 
-### 分页所有获取从某个(my-object-xx)之后的object,每次返回50条。
+### 分页所有获取从特定Object后的所有的Object,每次返回50条
 ```go
     marker = oss.Marker("my-object-xx")
     for {
@@ -104,7 +104,7 @@
     }
 ```
  
-### 分页所有获取前缀为my-object-的object,每次返回80个。
+### 分页所有获取指定前缀为的Object,每次返回80个。
 ```go
     prefix := oss.Prefix("my-object-")
     marker := oss.Marker("")
@@ -178,7 +178,7 @@ OSS是基于对象的存储服务,没有目录的概念。存储在一个Bucke
 ``` 
 
 
-## 删除个文件
+## 删除个文件
 
 通过`Bucket.DeleteObject`来删除某个文件:
 ```go
@@ -243,7 +243,7 @@ OSS是基于对象的存储服务,没有目录的概念。存储在一个Bucke
 > - Bucket.DeleteObjects使用的Go的xml包,该包实现了XML1.0标准,XML1.0不支持的特性请不要使用。
 >
 
-## 获取文件的文件元信息(Object Meta)
+## 获取文件的元信息(Object Meta)
 
 OSS上传/拷贝文件时,除了文件内容,还可以指定文件的一些属性信息,称为“元信息”。这些信息在上传时与文件一起存储,在下载时与文件一起返回。
 

+ 3 - 3
doc/自定义域名绑定.md

@@ -2,7 +2,7 @@
 
 OSS支持用户将自定义的域名绑定到OSS服务上,这样能够支持用户无缝地将存储
 迁移到OSS上。例如用户的域名是my-domain.com,之前用户的所有图片资源都是
-形如`http://img.my-domain.com/x.jpg`的格式,用户将图片存储迁移到OSS之
+形如`http://img.my-domain.com/xx.jpg`的格式,用户将图片存储迁移到OSS之
 后,通过绑定自定义域名,仍可以使用原来的地址访问到图片:
 
 - 开通OSS服务并创建Bucket
@@ -15,7 +15,7 @@ OSS支持用户将自定义的域名绑定到OSS服务上,这样能够支持
 的图片。
 绑定自定义域名请参考[自定义域名绑定]({{doc/[8]用户手册/基本概念/自定义域名访问OSS.md}})
 
-在使用SDK时,可以使用自定义域名作为endpoint,这时需要将`UseCname`参数
+在使用SDK时,可以使用自定义域名作为endpoint,这时需要将`UseCname`参数
 设置为true,如下面的例子:
 
 > 提示:
@@ -70,5 +70,5 @@ OSS支持用户将自定义的域名绑定到OSS服务上,这样能够支持
 
 > 注意:
 > 
-> - 使用CNAME时,无法使用list_buckets接口。(因为自定义域名已经绑定到
+> - 使用Cname时,无法使用list_buckets接口。(因为自定义域名已经绑定到
 >   某个特定的Bucket)