Skip to content

openApiSpecのディレクトリ構成変更および識別子変更 #35

@maccostar

Description

@maccostar

client/static/openApiSpecのディレクトリ構成変更および識別子の変更

Description

ディレクトリ構成変更

OpenApiSpecで表現できないmetadataの出現(カテゴリ/icon)等のために、以下の通りにディレクトリ構成を変更する。

  • AsIs(変更前)
static/openApiSpec/
├ 0a0e102cd6d8a8fcd03a4c88191fe870c3d02681dfa42a6883b909e0bbe27a0b.json
├ 0a2de018b08226f4da94a9530edf7d92aa0902722928b074e8b3b6c647dd4750.json
(中略)
└ fffd7cd27e284a9f545624be251277ab5d22a0b021adb82e888c4a5b3fb92774.json

  • ToBe(変更後)
static/openApiSpec/
├ virtserver.swaggerhub.com%raviteja786143%Shikshan%1.0.0/
│ ├ openApi.json
│ ├ metadata.json(optional)
│ ├ package.json(optional)
│ └ icon/
│     └***.icon(optional)
├ virtserver.swaggerhub.com%nims%nims%1.0.0/
│ ├ openApi.json
│ ├ metadata.json
│ ├ package.json
│ └ icon/
│     └***.icon
(中略)
└ api.paymentsos.com/
  ├ openApi.json
  ├ metadata.json
  ├ package.json
  └ icon/
      └***.icon

識別子の変更

現状のSHA256変換した後の識別子ではapilist.jsonのデータ量が重くなってしまうため、BaseURLのドメイン部分のみを抽出して変換する。

  • AsIs(変更前)
    OpenAPIObjetct.serversに格納された最初のServerObjectのURLをSHA256に変換したもの。

  • ToBe(変更後)
    OpenAPIObjetct.serversに格納された最初のServerObjectのURLを抽出する。
    URLをツール(未調査。Decode-URL-filestream(?))等で、/部分を%等に書き換え、ファイル保存が可能な形式に変更する。

  • 補足
    serversのTypeは、ServerObject[]である。
    http://~~~,https://~~~と複数のbaseURLを設定できる。

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions