カスタムレイアウトの作成

レイアウトは、Swagger UI がアプリケーション全体のルートコンポーネントとして使用する特別なタイプのコンポーネントです。カスタムレイアウトを定義することで、ページに表示される内容を高度に制御できます。

デフォルトでは、Swagger UI はアプリケーションに組み込まれている BaseLayout を使用します。layout パラメーターとしてレイアウト名を Swagger UI に渡すことで、別のレイアウトを指定できます。カスタムレイアウトを Swagger UI のコンポーネントとして必ず提供してください。

たとえば、操作のみを表示するカスタムレイアウトを作成したい場合は、OperationsLayout を定義できます。

import React from "react"

// Create the layout component
class OperationsLayout extends React.Component {
  render() {
    const {
      getComponent
    } = this.props

    const Operations = getComponent("operations", true)

    return (
      <div className="swagger-ui">
        <Operations />
      </div>
    )
  }
}

// Create the plugin that provides our layout component
const OperationsLayoutPlugin = () => {
  return {
    components: {
      OperationsLayout: OperationsLayout
    }
  }
}

// Provide the plugin to Swagger-UI, and select OperationsLayout
// as the layout for Swagger-UI
SwaggerUI({
  url: "https://petstore.swagger.io/v2/swagger.json",
  plugins: [ OperationsLayoutPlugin ],
  layout: "OperationsLayout"
})

デフォルトレイアウトの拡張

BaseLayout を置き換えるのではなく、BaseLayout をカスタムレイアウトに組み込んで使用することもできます。

import React from "react"

// Create the layout component
class AugmentingLayout extends React.Component {
  render() {
    const {
      getComponent
    } = this.props

    const BaseLayout = getComponent("BaseLayout", true)

    return (
      <div>
        <div className="myCustomHeader">
          <h1>I have a custom header above Swagger-UI!</h1>
        </div>
        <BaseLayout />
      </div>
    )
  }
}

// Create the plugin that provides our layout component
const AugmentingLayoutPlugin = () => {
  return {
    components: {
      AugmentingLayout: AugmentingLayout
    }
  }
}

// Provide the plugin to Swagger-UI, and select AugmentingLayout
// as the layout for Swagger-UI
SwaggerUI({
  url: "https://petstore.swagger.io/v2/swagger.json",
  plugins: [ AugmentingLayoutPlugin ],
  layout: "AugmentingLayout"
})