Skip to content

CHANGES.md

Latest commit

 

History

History
83 lines (60 loc) · 2.46 KB

CHANGES.md

File metadata and controls

83 lines (60 loc) · 2.46 KB

Resumo das Alterações - Corrigido Erro e Adicionada Documentação Swagger

🔧 Erro Corrigido

Problema:

Call to undefined method App\\Providers\\SuperflixProvider::canUserSuffix()

Causa: Havia um typo no arquivo src/Support/Traits/SearchEngine.php - o método era chamado como canUserSuffix() mas o correto é canUseSuffix() (está definido em MediaProviderRulesInterface).

Solução: Substituído todos os canUserSuffix() por canUseSuffix() nas linhas 23 e 33 do arquivo SearchEngine.php.

Arquivo modificado:

📚 Documentação Swagger Adicionada

Arquivos Criados:

  1. public/openapi.json

    • Schema OpenAPI 3.0.0 completo
    • Contém definição de todos os endpoints, parâmetros e respostas
    • Schemas de componentes para EpisodeResponse e ErrorResponse

  2. src/Controller/SwaggerController.php

    • Controller para servir Swagger UI
    • Rotas:
      • GET /api/doc - Interface Swagger UI
      • GET /api/doc.json - JSON Schema OpenAPI
      • GET /openapi.json - Acesso público ao schema

  3. src/Controller/MediaController.php - Atualizado

    • Adicionadas anotações Swagger/OpenAPI completas
    • Documentação detalhada do endpoint /episode/{slug}/{season}/{episodeNumber}
    • Exemplos de respostas para sucesso e erro

  4. config/packages/swagger.yaml

    • Configuração básica do Swagger

  5. config/routes/swagger.yaml

    • Definição de rotas para documentação

  6. SWAGGER.md

    • Guia de uso da documentação Swagger
    • Exemplos de curl
    • Informações sobre providers e códigos de status

🚀 Como Acessar a Documentação

Interface Swagger UI

http://localhost/api/doc

JSON Schema

http://localhost/api/doc.json
ou
http://localhost/openapi.json

Exemplo de Requisição

curl -X GET "http://localhost/episode/naruto/1/1" \
  -H "Accept: application/json"

✅ Próximas Etapas

  1. Reiniciar o servidor para aplicar as alterações
  2. Acessar http://localhost/api/doc para visualizar a documentação
  3. Testar os endpoints através da interface Swagger UI
  4. Opcionalmente, instalar o NelmioApiDocBundle para integração mais profunda