15/05/27/00 – Notas da versão do Portal de serviços para desenvolvedores da Apigee

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Na terça-feira, 2 de junho de 2015, lançamos uma nova versão na nuvem do portal de serviços para desenvolvedores da Apigee.

Se tiver dúvidas, acesse o suporte ao cliente da Apigee.

Para conferir uma lista de todas as notas da versão do Apigee Edge, consulte Notas da versão do Apigee.

Novos recursos

Disponibilidade geral do SmartDocs

O SmartDocs está saindo da versão Beta e vai ser disponibilizado para todos os usuários. As atualizações e os novos recursos incluem:

  • Suporte ao Swagger 2.0, incluindo importação por arquivo ou URL, incluindo suporte a objetos de segurança com nomes personalizados.
  • Melhorias no design visual dos modelos que geram SmartDocs.
  • Melhorias na usabilidade e no fluxo de trabalho no portal do desenvolvedor, disponíveis no menu "Conteúdo" > "SmartDocs" no Drupal.
  • O que era conhecido como autenticação de "Token personalizado" agora é chamado de "Chave de API".
  • Objetos de "segurança" de autenticação definidos no nível de revisão.
  • Configuração da autenticação do cliente no nível do modelo. As novas revisões não redefiniram mais nenhuma credencial de cliente pré-configurada do SmartDocs.

Para mais descrições de recursos, consulte esta postagem do blog.

Para conferir a documentação do SmartDocs, consulte Como usar o SmartDocs para documentar APIs.

Processo de upgrade do SmartDocs

Se você já estava usando o SmartDocs durante o período Beta, os novos recursos e recursos na versão de disponibilidade geral exigem que você faça upgrade do SmartDocs no portal do desenvolvedor.

As páginas do SmartDocs que já foram publicadas no seu portal de desenvolvedores vão continuar funcionando, mas você precisa seguir o processo de atualização antes de editar ou publicar as mudanças nas páginas atuais ou novas.

É possível renderizar e publicar SmartDocs no portal do desenvolvedor, mas eles são gerados com base no modelo de API que está nos serviços de gerenciamento de API do Edge da Apigee. Todas as mudanças feitas em um modelo de API no Edge serão as mesmas em todos os ambientes do Pantheon, semelhante à forma como os desenvolvedores existem em todos os ambientes do Pantheon.

Para fazer upgrade da versão Beta do SmartDocs para a versão de disponibilidade geral

  1. Atualize e teste a versão 15.05.27 nos ambientes de desenvolvimento ou teste no Pantheon.
  2. Crie um novo modelo para substituir qualquer modelo de API que você esteja usando.
    • Se você estiver importando documentos Swagger ou WADL, importe-os novamente para uma nova revisão.
    • Se você estiver mantendo seu modelo de API pelo módulo SmartDocs, exporte como JSON do SmartDocs e importe para o novo modelo usando o anexo de arquivo.
  3. Defina as propriedades de segurança da revisão do modelo. Na página Conteúdo > SmartDocs > modelo, selecione Configurações de segurança.
  4. Verifique qualquer autenticação pré-configurada na página de configurações do modelo (Conteúdo > SmartDocs) clicando em Configurações na coluna "Operações".
  5. Atualize os modelos personalizados para usar a v6 dos recursos de CSS e JS e faça mudanças para refletir novos nomes de objetos, como authSchemes e apiSchema. Para informações sobre como atualizar modelos do SmartDocs, consulte Como usar SmartDocs para documentar APIs.
  6. Renderize e publique a revisão do modelo.
  7. Depois de validar a nova documentação, atualize o portal de produção para a versão 15.05.27.

Se você é um cliente empresarial do Edge e tem dúvidas sobre o processo de upgrade, envie um e-mail para marsh@apigee.com e cnovak@apigee.com. Caso contrário, use a Comunidade da Apigee para receber a melhor resposta.

Bugs corrigidos

Os bugs abaixo foram corrigidos nesta versão.

ID do problema Descrição
DEVSOL-487 O formato de dia na monetização precisa ser configurável pelos administradores
Agora, o formato de data pode ser configurado em "Monetização" nas configurações de monetização para formatos de data europeus e dos EUA.
DEVSOL-603 A página "Conflict Plan" está com o formato incorreto
Ao comprar um plano que se sobrepõe a um plano existente, a página mostrada agora está formatada corretamente para o usuário.
DEVSOL-642 Mover as configurações do cliente das configurações de segurança para as configurações do modelo
DEVSOL-709 SmartDocs: o parâmetro do modelo de URL não pode ser editado depois de enviar uma solicitação com valor em branco
Corrige o problema que torna os parâmetros do modelo não editáveis depois de enviar a solicitação do SmartDocs após excluir o parâmetro do modelo na documentação do método.
DEVSOL-1013 Edição de endereços de e-mail de usuários no portal do desenvolvedor
O campo de endereço de e-mail na página de edição do perfil não será mais desativado, e os desenvolvedores poderão mudar os próprios endereços de e-mail.
DEVSOL-1273 "DevConnect Mint" aparece duas vezes na lista de módulos
Em "Módulos", "Dev Connect Mint" apareceu duas vezes. Isso já foi corrigido
DEVSOL-1313 Suporte à importação de arquivos JSON/YAML ou URL para Swagger e WADL
Agora é possível importar arquivos WADL por URL e fazer upload de arquivos Swagger.
DEVSOL-1339 Mudanças nos locais do menu "Administrador" do SmartDocs
Agora o SmartDocs está localizado no menu "Conteúdo", e as configurações do SmartDocs estão no menu "Administrador".
DEVSOL-1340 Remover a versão Beta ao acessar a GA
O SmartDocs agora está localizado no menu de conteúdo, e as configurações do SmartDocs estão no menu de configurações da administração.
DEVSOL-1390 A biblioteca do SDK do PHP Edge foi atualizada para corrigir o problema de chamada de __toString()
A biblioteca do SDK do PHP Edge foi atualizada para corrigir o problema de chamada de __toString() no objeto DeveloperRatePlan, que cria este erro: {quote} Erro fatal: chamada para uma função format() de membro em um não objeto em /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php na linha 221 {quote} Este é um bug que afeta apenas os clientes da Monetização com código personalizado que chama o método toString().
DEVSOL-1398 O modelo da Petstore do SmartDocs é importado na instalação sem solicitar ao usuário
O SmartDocs agora importa o exemplo de swagger da Petstore durante a instalação do site (http://petstore.swagger.io/v2/swagger.json) em vez do modelo de clima para ter um exemplo mais completo de uso do SmartDocs.
DEVSOL-1407 O cron falha quando há muitos desenvolvedores
Ao executar o cron do Drupal, uma grande quantidade de desenvolvedores causou um problema de tempo limite. Quando uma organização tem mais de 200 usuários, um processo em lote é usado.
DEVSOL-1470 Criar link de menu "APIs" e visualização correspondente
O portal do desenvolvedor SmartDocs agora vem por padrão com um link para a documentação renderizada do SmartDocs no menu principal "APIs", que vincula a todos os modelos com métodos publicados.

Problemas conhecidos

Esta versão contém os seguintes problemas conhecidos:

ID do problema Descrição
DEVSOL-1558
As páginas de método do exemplo de Petstore SmartDocs não são renderizadas corretamente em uma nova instalação
As páginas de exemplo do método Petstore no SmartDocs não são renderizadas corretamente em uma nova instalação. Para corrigir esse problema:
  1. Selecione Conteúdo > SmartDocs no menu do Drupal.
  2. Selecione o modelo "Exemplo de pet shop".
  3. Selecione Renderizar e publicar nós em Opções de atualização.
  4. Clique na caixa de seleção Selecionar / Desmarcar tudo para selecionar todos os nós.
  5. Clique em Atualizar.

Os nós devem ser renderizados corretamente agora.