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

Você está lendo 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 você tiver dúvidas, entre em contato com o suporte do Apigee Edge.

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

Novos recursos

Disponibilidade geral do SmartDocs

O SmartDocs está saindo da versão Beta e entrando na disponibilidade geral. As atualizações e os novos recursos incluem:

  • Suporte ao Swagger 2.0, incluindo importação por arquivo ou URL, e suporte a objetos de segurança com nomes personalizados.
  • Melhorias no design visual dos modelos que geram o SmartDocs.
  • Melhorias de usabilidade e fluxo de trabalho no portal do desenvolvedor, disponível 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 da revisão.
  • Configuração da autenticação do cliente no nível do modelo. As novas revisões não redefinem mais as credenciais de cliente do SmartDocs pré-configuradas.

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

Para 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 funcionalidades da versão de disponibilidade geral exigem que você faça upgrade do SmartDocs no portal do desenvolvedor.

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

Embora seja possível renderizar e publicar o SmartDocs no portal do desenvolvedor, ele é gerado a partir do modelo de API que reside 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 a como os desenvolvedores existem em ambientes do Pantheon).

Para fazer upgrade do SmartDocs Beta para a 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ê estava importando documentos Swagger ou WADL, importe-os novamente para uma nova revisão.
    • Se você estava mantendo o 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 todos os modelos personalizados para usar a versão 6 dos recursos CSS e JS e faça mudanças para refletir quaisquer novos nomes de objetos, como authSchemes e apiSchema. Para informações sobre como atualizar modelos do SmartDocs, consulte Como usar o SmartDocs para documentar APIs.
  6. Renderize e publique novamente 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 corporativo do Edge e tem dúvidas ou preocupações 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 admins
O formato de data agora pode ser configurado na monetização em "Configurações de monetização" para formatos de data europeus e dos EUA.
DEVSOL-603 A página "Plano de conflito" está mal formatada
Ao comprar um plano que se sobrepõe a um plano atual, a página mostrada agora é formatada corretamente para o usuário.
DEVSOL-642 Mover as configurações de nível do cliente das configurações de segurança para as configurações do modelo settings
DEVSOL-709 SmartDocs: o parâmetro de modelo de URL não pode ser editado após o envio da solicitação com valor vazio Corrige o problema que torna os parâmetros do modelo não editáveis após o envio da solicitação do SmartDocs depois de excluir o parâmetro do modelo na documentação do método.
DEVSOL-1013 Tornar os endereços de e-mail do usuário do portal do desenvolvedor editáveis
O campo de endereço de e-mail na página do perfil de edição não será mais desativado, e os desenvolvedores poderão mudar os endereços de e-mail.
DEVSOL-1273 "DevConnect Mint" aparece duas vezes na lista de módulos
Em "Módulos", "Dev Connect Mint" era exibido duas vezes. Isso já foi corrigido
DEVSOL-1313 Suporte à importação de arquivos JSON/YAML ou URL para Swagger e WADL
Os arquivos WADL agora podem ser importados por URL, e os arquivos Swagger podem ser enviados.
DEVSOL-1339 Mudar os locais do menu de admin do SmartDocs
O SmartDocs agora está localizado no menu de conteúdo, e as configurações do SmartDocs estão no menu de admin de configurações.
DEVSOL-1340 Remover a versão Beta ao passar para a disponibilidade geral
O SmartDocs agora está localizado no menu de conteúdo, e as configurações do SmartDocs estão no menu de admin de configurações.
DEVSOL-1390 A biblioteca do SDK do PHP Edge foi atualizada para corrigir o problema de chamar __toString()
A biblioteca do SDK do PHP Edge foi atualizada para corrigir o problema de chamar __toString() no objeto DeveloperRatePlan, que cria este erro: {quote} Erro fatal: chamada para uma função de membro format() 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} Esse é um bug que afeta apenas clientes de monetização com código personalizado que chama o método toString().
DEVSOL-1398 O modelo de Petstore do SmartDocs foi importado na instalação sem solicitar ao usuário
O SmartDocs agora importa o exemplo do 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 exaustivo de uso do SmartDocs.
DEVSOL-1407 O cron falha quando há muitos desenvolvedores
Ao executar o cron do Drupal, um grande número 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 um link de menu "APIs" e a visualização correspondente
O SmartDocs do portal do desenvolvedor agora vem por padrão com um link para a documentação renderizada do SmartDocs no menu principal chamado "APIs", que se 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 SmartDocs de exemplo da petstore não são renderizadas corretamente em uma nova instalação
As páginas de método de exemplo da 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 petstore".
  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 agora serão renderizados corretamente.