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

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

ただいまの
回答率

88.63%

TypeScriptでOpenAPIV3.Documentの型をつけたい

受付中

回答 0

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 322

maccostar

score 6

前提・実現したいこと

Nuxt-TypeScriptでSwagger-UIもどきを作成しています。
OpenAPISpecV3に準拠したJSONを、Swagger-Parser経由でOpenAPISpecV3.Document型をつけて受け取りたいです。

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

Swagger-Parserを経由するとconst apiにいるはずのkeyserversが取得できず以下の静的エラーが検出されます。

ERROR  ERROR in /(省略)/client/pages/apiDoc.vue(29,21):                                                                            nuxt:typescript 21:25:30
29:21 Property 'servers' does not exist on type 'Document'.
    27 | 
    28 |     console.log(Object.keys(api))
  > 29 |     console.log(api.servers)
       |                     ^
    30 | 
    31 |     const isV3 = (openapi: OpenAPI.Document): openapi is OpenAPIV3.Document =>
    32 |       'openapi' in openapi

該当のソースコード

<script lang="ts">
import { Component, Vue } from 'nuxt-property-decorator'
import SwaggerParser from 'swagger-parser'
import { OpenAPI, OpenAPIV3 } from 'openapi-types'

@Component({
  async asyncData({ route }) {
    const apiServiceId = route.query.apiServiceId
    const api =
      (await SwaggerParser.parse(`/openApiSpec/${apiServiceId}.json`, {
        parse: { json: true }
      })) || {}

    // 以下の実行結果は次の通り。["info", "openapi", "servers", "paths", "components", "tags"]
    console.log(Object.keys(api))
    // 以下はエラー「Property 'servers' does not exist on type 'Document'.」となる
    console.log(api.servers)

    const isV3 = (openapi: OpenAPI.Document): openapi is OpenAPIV3.Document =>
      'openapi' in openapi

    // 以下の実行結果はtrue。
    console.log(isV3(api))

    return {
      apiDoc: api
    }
  }
})
export default class extends Vue {}
</script>
{
  "info": {
      "title": "tchop app",
      "version": "0.0.1",
      "description": "省略"
  },
  "openapi": "3.0.0",
  "servers": [
      {
          "url": "https://tchop.io"
      }
  ],
(中略)
}

補足情報(FW/ツールのバージョンなど)

  • 使用したJSON(SwaggerHubから拝借)
    https://app.swaggerhub.com/apiproxy/registry/tchop.io/tchop/0.0.1

  • SwaggerParser
    https://github.com/APIDevTools/swagger-parser

  • Nuxt-TSの設定
    https://github.com/m-mitsuhide/nuxt-ts-starter

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

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

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

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

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

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

  • ただいまの回答率 88.63%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る