-
-
Notifications
You must be signed in to change notification settings - Fork 533
feat: Japanese translation for docs #1855
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
4ce4aeb
docs(ja): openapi-typescript, about
yoshi2no 24532b7
docs(ja): openapi-typescript, advanced
yoshi2no 013c9d4
docs(ja): openapi-typescript, cli
yoshi2no fbcaec3
docs(ja): openapi-typescript, examples
yoshi2no 18fd6a3
docs(ja): openapi-typescript, index
yoshi2no 97dc083
docs: fix invalid url
yoshi2no 6bc7c69
docs(ja): openapi-typescript, introduction
yoshi2no 8a8626e
docs(ja): openapi-typescript, migration-guide
yoshi2no 36245c6
docs(ja): openapi-typescript, node
yoshi2no c84b3f2
docs(ja): openapi-fetch, about
yoshi2no e16bfb2
docs(ja): openapi-fetch, api
yoshi2no 80a5bce
docs(ja): openapi-fetch, examples
yoshi2no ca4a6c9
docs(ja): openapi-fetch, index
yoshi2no 922ddf2
docs(ja): openapi-fetch, middleware-auth
yoshi2no f7761bf
docs(ja): openapi-fetch, testing
yoshi2no dd19bb0
docs(ja): openapi-react-query, about
yoshi2no c41d318
docs(ja): openapi-react-query, index
yoshi2no 097e944
docs(ja): openapi-react-query, use-mutation
yoshi2no 46d825d
docs(ja): openapi-react-query, use-query
yoshi2no ba8fbde
docs(ja): openapi-react-query, use-suspense-query
yoshi2no 11ed757
feat: add vitepress `ja` config
yoshi2no e638141
Merge branch 'main' into feature/docs-ja/yoshi2no
yoshi2no 01421c2
docs(ja): update content, fix typo and links
yoshi2no f42bea9
docs(en, zh): fix link
yoshi2no e2e888a
Deploy to Cloudflare
drwpow File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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,114 @@ | ||
import { defineConfig, type DefaultTheme } from "vitepress"; | ||
|
||
export default defineConfig({ | ||
lang: "ja", | ||
description: "OpenAPI 3.0および3.1のスキーマをTypeScriptで使用する方法。", | ||
themeConfig: { | ||
nav: [ | ||
{ | ||
text: "バージョン", | ||
items: [ | ||
{ text: "7.x", link: "/ja/introduction" }, | ||
{ text: "6.x", link: "/6.x/introduction" }, | ||
], | ||
}, | ||
], | ||
sidebar: { | ||
"/ja/": [ | ||
{ | ||
text: "openapi-typescript (7.x)", | ||
items: [ | ||
{ text: "イントロダクション", link: "/ja/introduction" }, | ||
{ text: "CLI", link: "/ja/cli" }, | ||
{ text: "Node.js API", link: "/ja/node" }, | ||
{ text: "使用例", link: "/ja/examples" }, | ||
{ text: "6.xからのマイグレーション", link: "/ja/migration-guide" }, | ||
{ text: "高度な機能", link: "/ja/advanced" }, | ||
{ text: "概要", link: "/ja/about" }, | ||
], | ||
}, | ||
{ | ||
text: "openapi-fetch", | ||
items: [ | ||
{ text: "始める", link: "/ja/openapi-fetch/" }, | ||
{ | ||
text: "ミドルウェア & 認証", | ||
link: "/ja/openapi-fetch/middleware-auth", | ||
}, | ||
{ text: "テスト", link: "/ja/openapi-fetch/testing" }, | ||
{ text: "使用例", link: "/ja/openapi-fetch/examples" }, | ||
{ text: "API", link: "/ja/openapi-fetch/api" }, | ||
{ text: "概要", link: "/ja/openapi-fetch/about" }, | ||
], | ||
}, | ||
{ | ||
text: "openapi-react-query", | ||
items: [ | ||
{ text: "始める", link: "/ja/openapi-react-query/" }, | ||
{ text: "useQuery", link: "/ja/openapi-react-query/use-query" }, | ||
{ text: "useMutation", link: "/ja/openapi-react-query/use-mutation" }, | ||
{ text: "useSuspenseQuery", link: "/ja/openapi-react-query/use-suspense-query" }, | ||
{ text: "概要", link: "/ja/openapi-react-query/about" }, | ||
], | ||
}, | ||
], | ||
}, | ||
|
||
docFooter: { | ||
prev: "前のページ", | ||
next: "次のページ", | ||
}, | ||
outline: { | ||
label: "目次", | ||
}, | ||
sidebarMenuLabel: "メニュー", | ||
returnToTopLabel: "最上部に戻る", | ||
footer: { | ||
message: | ||
'<a href="https://github.com/openapi-ts/openapi-typescript/blob/main/packages/openapi-typescript/LICENSE">MITライセンス</a> に基づいて配布されています。', | ||
}, | ||
}, | ||
}); | ||
|
||
export const jaSearch: DefaultTheme.AlgoliaSearchOptions["locales"] = { | ||
ja: { | ||
placeholder: "ドキュメントを検索", | ||
translations: { | ||
button: { | ||
buttonText: "検索", | ||
buttonAriaLabel: "検索", | ||
}, | ||
modal: { | ||
searchBox: { | ||
resetButtonTitle: "クエリをクリア", | ||
resetButtonAriaLabel: "クエリをクリア", | ||
cancelButtonText: "キャンセル", | ||
cancelButtonAriaLabel: "キャンセル", | ||
}, | ||
startScreen: { | ||
recentSearchesTitle: "最近の検索", | ||
noRecentSearchesText: "最近の検索履歴はありません", | ||
saveRecentSearchButtonTitle: "最近の検索に保存", | ||
removeRecentSearchButtonTitle: "最近の検索から削除", | ||
favoriteSearchesTitle: "お気に入り", | ||
removeFavoriteSearchButtonTitle: "お気に入りから削除", | ||
}, | ||
errorScreen: { | ||
titleText: "結果を取得できません", | ||
helpText: "ネットワーク接続を確認してください", | ||
}, | ||
footer: { | ||
selectText: "選択", | ||
navigateText: "移動", | ||
closeText: "閉じる", | ||
}, | ||
noResultsScreen: { | ||
noResultsText: "関連する結果が見つかりません", | ||
suggestedQueryText: "別のクエリを試してみてください", | ||
reportMissingResultsText: "このクエリに結果があるべきだと思いますか?", | ||
reportMissingResultsLinkText: "フィードバックを送信", | ||
}, | ||
}, | ||
}, | ||
}, | ||
}; |
This file contains hidden or 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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
This file contains hidden or 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,60 @@ | ||
--- | ||
title: openapi-typescriptについて | ||
description: このプロジェクトに関する追加情報 | ||
--- | ||
|
||
<script setup> | ||
import { VPTeamMembers } from 'vitepress/theme'; | ||
import contributors from '../data/contributors.json'; | ||
</script> | ||
|
||
# openapi-typescriptについて | ||
|
||
## 利用者 | ||
|
||
- [**Bigcommerce**](https://github.com/bigcommerce/bigcommerce-api-node): BigCommerce API 用の Node SDK | ||
- [**Budibase**](https://github.com/Budibase/budibase): 内部ツール、ワークフロー、および管理ダッシュボードを作成するためのローコードプラットフォーム | ||
- [**Fedora `fmn`**](https://github.com/fedora-infra/fmn): Fedora メッセージインフラストラクチャのツールと API | ||
- [**Fingerprint**](https://github.com/fingerprintjs/fingerprintjs-pro-server-api-node-sdk): 大規模なアプリケーション向けのデバイスフィンガープリンティング | ||
- [**Google Firebase CLI**](https://github.com/firebase/firebase-tools): Google Firebase プラットフォーム用の公式 CLI | ||
- [**GitHub Octokit**](https://github.com/octokit): GitHub API の公式 SDK | ||
- [**Lotus**](https://github.com/uselotus/lotus): オープンソースの価格設定およびパッケージングインフラストラクチャ | ||
- [**Jitsu**](https://github.com/jitsucom/jitsu): モダンでオープンソースのデータ収集/データパイプライン | ||
- [**Medusa**](https://github.com/medusajs/medusa): デジタルコマースの構築ブロック | ||
- [**Netlify**](https://netlify.com): モダンな開発プラットフォーム | ||
- [**Nuxt**](https://github.com/unjs/nitro): 直感的な Vue フレームワーク | ||
- [**Relevance AI**](https://github.com/RelevanceAI/relevance-js-sdk): AI チェーンの構築と展開 | ||
- [**Revolt**](https://github.com/revoltchat/api): オープンソースのユーザー優先チャットプラットフォーム | ||
- [**Spacebar**](https://github.com/spacebarchat): 無料でオープンソースの自ホスト可能な Discord 互換のチャット/音声/ビデオプラットフォーム | ||
- [**Supabase**](https://github.com/supabase/supabase): オープンソースの Firebase 代替 | ||
- [**Twitter API**](https://github.com/twitterdev/twitter-api-typescript-sdk): Twitter API の公式 SDK | ||
|
||
## プロジェクトの目標 | ||
|
||
1. 任意の有効な OpenAPI スキーマを TypeScript 型に変換できるようにすること。どんなに複雑なスキーマでも対応可能です。 | ||
2. 生成される型は静的に解析可能で、実行時の依存関係がない(ただし、[enums](https://www.typescriptlang.org/docs/handbook/enums.html) のような例外はあります)。 | ||
3. 生成された型は、元のスキーマにできるだけ一致し、元の大文字形式などを保持します。 | ||
4. 型の生成 は Node.js だけで実行可能であり、(Java、Python などは不要)どんな環境でも実行できます。 | ||
5. ファイルからの OpenAPI スキーマのフェッチや、ローカルおよびリモートサーバーからのフェッチをサポートします。 | ||
|
||
## 比較 | ||
|
||
### vs. swagger-codegen | ||
|
||
openapi-typescript は、swagger-codegen の軽量で使いやすい代替手段として作成されており、Java ランタイムや OpenAPI サーバーを実行する必要はありません。また、大規模なクライアントサイドコードも生成しません。実際、openapi-typescript が生成するすべてのコードは、**実行時の依存関係がない静的型** であり、最大のパフォーマンスと最小のクライアント負荷を実現します。 | ||
|
||
### vs. openapi-typescript-codegen | ||
|
||
openapi-typescript-codegen は、元の swagger-codegen の Node.js 代替手段ですが、実際には同じものです。openapi-typescript は、openapi-typescript-codegen と同様に、**実行時の依存関係がない** という利点を持っていますが、openapi-typescript-codegen は、スキーマの複雑さに応じて `250 kB` 以上になるかなり大きなバンドルを生成する可能性があります。 | ||
|
||
### vs. tRPC | ||
|
||
[tRPC](https://trpc.io/) は、強い設計方針を持ったサーバーとクライアントの両方で型の安全性を提供するフレームワークです。これは、サーバーとクライアントの両方が tRPC で記述されていることを要求します(つまり、バックエンドが Node.js を使用しています)。 | ||
|
||
このユースケースに合っているならば、素晴らしい体験ができるでしょう!しかし、他のすべての場合において、openapi-typescript(および openapi-fetch)は、あらゆる技術選択に適応できる、より柔軟で低レベルなソリューションです(コストなしで段階的に導入することさえできます)。 | ||
|
||
## 貢献者 | ||
|
||
これらの素晴らしい貢献者がいなければ、このライブラリは存在しなかったでしょう: | ||
|
||
<VPTeamMembers size="small" :members="contributors['openapi-typescript']" /> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the fix for the invalid link mentioned in the Changes same for zh doc.