-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from yamamoto-febc/design/init
design: init
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# object-storage-api-go | ||
|
||
- URL: https://github.com/sacloud/object-storage-api-go/pull/1 | ||
- Parent: https://github.com/sacloud/sacloud-go/pull/1 | ||
- Author: @yamamoto-febc | ||
|
||
## 概要 | ||
|
||
[さくらのクラウド オブジェクトストレージAPI](https://manual.sakura.ad.jp/cloud/objectstorage/api.html)をGo言語から利用するためのライブラリを提供する。 | ||
|
||
さくらのクラウドオブジェクトストレージAPIは専用サーバPHYと同じくOpenAPI v3.0でのAPI定義が公開されている。 | ||
|
||
- [さくらのクラウド オブジェクトストレージAPI OpenAPIでの定義](https://manual.sakura.ad.jp/cloud/objectstorage/api/api-json.html) | ||
|
||
このAPI定義を用いてGo言語向けのコードを生成する。 | ||
またより簡単に使うためのラップしたコードやテスト用モックサーバも提供する。 | ||
|
||
## やること/やらないこと | ||
|
||
### やること | ||
|
||
- OpenAPIでのAPI定義から生成したコードの提供 | ||
- 生成したコードをラップするコードの提供 | ||
- テスト用モックサーバの提供 | ||
- テスト用モックサーバを操作するためのCLIの提供 | ||
|
||
### やらないこと | ||
|
||
TODO: 必要に応じて記載 | ||
|
||
## 実装 | ||
|
||
- 基本的には[sacloud/phy-go](https://github.com/sacloud/phy-go)の実装を踏襲する | ||
- コード生成には[oapi-codegen](https://github.com/deepmap/oapi-codegen)を用いる | ||
- テスト用モックサーバには[gin](https://github.com/gin-gonic/gin)を用いる | ||
|
||
## 改訂履歴 | ||
|
||
- 2022/2/26: 初版作成 |