Deaktivieren Sie die Swagger-Benutzeroberfläche auf der API-Plattform

Question

Ich versuche, die Swagger-Benutzeroberfläche zu deaktivieren, oder genauer gesagt, weil ich möchte, dass wir sie nur für Nicht-Produktionsumgebungen bereitstellen.

Ich habe auf diesen Link verwiesen, aber nichts ist passiert.

Meine api_platform.yaml Datei:

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 仅在您的产品环境中被禁用。