在 API 平台上停用 Swagger UI

Question

我試圖停用 Swagger UI，或更準確地說，因為我希望我們僅為非產品環境提供它。

我引用了此鏈接，但是沒有任何反應。

我的 api_platform.yaml 檔案：

api_platform:
  defaults:
    route_prefix: '/%env(API_ROUTE)%'
    enable_docs: false
    enable_entrypoint: false
    enable_swagger_ui: false
  swagger:
    api_keys:
      JWT:
        name: Authorization
        type: header
  collection:
    pagination:
      enabled: true

Answer 1

api_platform:
  defaults:
    route_prefix: '/%env(API_ROUTE)%'
  swagger:
    api_keys:
      JWT:
        name: Authorization
        type: header
  collection:
    pagination:
      enabled: true
    
when@prod:
    api_platform:
        enable_docs: false
        enable_entrypoint: false
        enable_swagger_ui: false

你的 api_platform.yaml 看起來像這樣。如果您正確使用環境，那麼您的 swagger 僅在您的產品環境中被停用。