質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.35%
Swagger

Swaggerは、REST APIを定義するための標準仕様に基づいて構築された一連のオープンソースツール。REST APIの設計や構築、文書化、使用に便利なツールを提供。Swagger Specを書くことでドキュメント生成まで自動的に行い、さらにドキュメントから実際のリクエストを投げられます。

Q&A

0回答

2472閲覧

Swagger Editorで複数ファイルからServer、Clientのコードファイルを生成したい

buru7052

総合スコア5

Swagger

Swaggerは、REST APIを定義するための標準仕様に基づいて構築された一連のオープンソースツール。REST APIの設計や構築、文書化、使用に便利なツールを提供。Swagger Specを書くことでドキュメント生成まで自動的に行い、さらにドキュメントから実際のリクエストを投げられます。

0グッド

0クリップ

投稿2021/06/01 06:03

お世話になります。
Swagger EditorのGenerateServer、Clientで質問があります。

実現したいこと

OpenAPI(Swagger)を使ってAPIの定義を記載してます。
コンポーネントの参照先が別のファイルにしているため、SwaggerEditorでファイルを開いたときにエラーが発生してしまいServer、Clientのコードファイルが生成できません。
解決策をご教授お願い致します。

ファイル構成は下記になります。

┌ components(共通のコンポーネントファイルが格納されているフォルダ) │ └ △△△.yaml(参照元であるコンポーネントが記述されているyamlファイル) └ 〇〇〇.yaml(△△△.yamlのコンポーネントを参照している。このファイルからコードファイルを生成したい)

発生している問題・エラーメッセージ

SwaggerEditor(Dockerで起動している)で表示されるエラー

Could not resolve reference: Tried to resolve a relative URL, without having a basePath. path: 'components/△△△.yaml' basePath: 'undefined' Jump to line 38

該当のソースコード

△△△.yaml(該当箇所のみ抜粋)

yaml

1 2components: 3 schemas: 4 projectInfo: 5 description: "プロジェクト情報" 6 type: String

〇〇〇.yaml(該当箇所のみ抜粋)

yaml

1responses: 2 "200": 3 description: 4  "Success operation" 5 content: 6   application/json: 7 schema: 8 $ref: "components/△△△.yaml#/components/schemas/projectInfo"

〇〇〇.yaml の$ref: "components/△△△.yaml#/components/schemas/projectInfo"で参照をしてます。

補足情報

OpenAPIのバージョン・・・"3.0.3"
SwaggerEditor・・・dockerの「swaggerapi/swagger-editor:v3.8.2」を使用

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだ回答がついていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.35%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問