Skip to content

ドキュメントにopenapiのpackageインストール方法を追加#10

Merged
yossydev merged 3 commits intomainfrom
feature/openapi-package-document
Nov 16, 2022
Merged

ドキュメントにopenapiのpackageインストール方法を追加#10
yossydev merged 3 commits intomainfrom
feature/openapi-package-document

Conversation

@yossydev
Copy link
Copy Markdown

やったこと

  • openapiのpackageを、web側でする方法を記載しました。

確認したいこと

  • server側は自分まだ試していないのですが、自分も一旦試した方がいいでしょうか...??

@yossydev yossydev self-assigned this Nov 16, 2022
@KazutakaShimizu
Copy link
Copy Markdown
Contributor

KazutakaShimizu commented Nov 16, 2022

server側は自分まだ試していないのですが、自分も一旦試した方がいいでしょうか...??

いや、API側はそっち開発する人が環境構築がてら書けばいい気がする

@muraikenta
Copy link
Copy Markdown
Collaborator

@somakihiro server側お願いします..!

Copy link
Copy Markdown
Contributor

@KazutakaShimizu KazutakaShimizu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 💯

@KazutakaShimizu
Copy link
Copy Markdown
Contributor

あ、ちょい待ち...?

@code-yy
これって追記してくれた部分って全部Radio-openapiのリポジトリでやんの?
一部はインストール先というか、今回のケースだとRadio-Webの方でやることになんのかな?

@yossydev
Copy link
Copy Markdown
Author

yossydev commented Nov 16, 2022

あ、ちょい待ち...?

@code-yy これって追記してくれた部分って全部Radio-openapiのリポジトリでやんの? 一部はインストール先というか、今回のケースだとRadio-Webの方でやることになんのかな?

Radio-Web/Radio-Serverそれぞれでインストールします!!
そこわかりづらかったですかね...??

@muraikenta
Copy link
Copy Markdown
Collaborator

Radio-Web のREADMEにこちらへのリンクを貼ってもらうイメージ

@KazutakaShimizu
Copy link
Copy Markdown
Contributor

あ、なるほど

Copy link
Copy Markdown
Contributor

@KazutakaShimizu KazutakaShimizu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 💯

README.md Outdated
$ npm run mockserver
```

### openapi のクライアント package インストール方法
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

これバックエンドも基本同じなので、「openapi の package インストール方法」でお願いします!

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/BucketFan/Radio-Web/pull/5 こちらにて修正しました!🙇‍♂️

4. パッケージをインストールする

```
$ yarn add @bucketfan/radio-api-client
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$ yarn add @bucketfan/radio-api-client
or
$ yarn add @bucketfan/radio-api-interfaces

にしてもらえるかな

README.md Outdated
```
$ yarn add @bucketfan/radio-api-client

$ yarn install
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

この行はいらないかな
yarn addでyarn install的な処理走るはずなので

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$ yarn add @bucketfan/radio-api-client or $ yarn add @bucketfan/radio-api-interfaces

にしてもらえるかな

90b25df 一つ前のレビュー内容の際にこちらも修正しました!🙇‍♂️

Copy link
Copy Markdown
Collaborator

@muraikenta muraikenta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@yossydev yossydev merged commit ffe8811 into main Nov 16, 2022
@yossydev yossydev deleted the feature/openapi-package-document branch November 16, 2022 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants