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

Em 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 da versão do Apigee Edge, consulte Notas da versão da Apigee.

Novos recursos

Disponibilidade geral do SmartDocs

Os SmartDocs estão saindo da versão Beta para a disponibilidade geral. As atualizações e os novos recursos incluem:

  • Suporte para Swagger 2.0, incluindo importação por arquivo ou URL, além de suporte para objetos de segurança com nomes personalizados.
  • Melhorias no design visual dos modelos que geram o 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 "Custom Token" agora é chamado de "API Key".
  • 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 conferir a documentação do SmartDocs, consulte Usar o SmartDocs para documentar APIs.

Processo de upgrade do SmartDocs

Se você já usava 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.

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

Embora seja possível renderizar e publicar o SmartDocs no portal de desenvolvedores, ele é gerado com base no modelo de API que fica 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, assim como os desenvolvedores.

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

  1. Atualize e teste a versão 15.05.27 nos ambientes dev ou test no Pantheon.
  2. Crie um 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ê 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 seu 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 v6 dos recursos de CSS e JS e faça mudanças para refletir todos os novos nomes de objetos, como authSchemes e apiSchema. Para informações sobre como atualizar modelos do SmartDocs, consulte 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 seu portal de produção para a versão 15.05.27.

Se você for um cliente corporativo do Edge e tiver 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 administradores
Agora, o formato de data 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 em conflito" está mal formatada
Ao comprar um plano que se sobrepõe a um plano existente, a página mostrada agora está formatada de maneira adequada para o usuário.
DEVSOL-642 Mover as configurações no nível do cliente das configurações de segurança para as configurações do modelo
DEVSOL-709 SmartDocs: o parâmetro de modelo de URL não pode ser editado depois de enviar uma solicitação com valor vazio
Corrige o problema que impede a edição dos parâmetros de modelo depois de enviar a solicitação do SmartDocs após excluir o parâmetro de modelo na documentação do método.
DEVSOL-1013 Tornar os endereços de e-mail dos usuários do Dev Portal editáveis
O campo de endereço de e-mail na página de edição de perfil 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" aparecia duas vezes. Isso já foi corrigido
DEVSOL-1313 Importação de arquivos JSON/YAML ou URLs para Swagger e WADL
Agora é possível importar arquivos WADL por URL e fazer upload de arquivos Swagger.
DEVSOL-1339 Mudar os locais do menu de administrador do SmartDocs
Agora o SmartDocs está no menu de conteúdo, e as configurações dele estão no menu de administrador de configurações.
DEVSOL-1340 Remover a versão Beta ao passar para a GA
O SmartDocs agora está localizado no menu de conteúdo, e as configurações dele estão no menu de administração de configurações.
DEVSOL-1390 A biblioteca PHP SDK Edge foi atualizada para corrigir o problema de chamar __toString()
A biblioteca PHP SDK Edge foi atualizada para corrigir o problema de chamar __toString() no objeto DeveloperRatePlan, que cria este erro: {quote} Fatal error: Call to a member function format() on a non-object in /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php on line 221 {quote} Esse é um bug que afeta apenas clientes da Monetização com código personalizado que chama o método toString().
DEVSOL-1398 Modelo da loja de animais do SmartDocs importado na instalação sem solicitar ao usuário
Agora, o SmartDocs importa o exemplo do Swagger da loja de animais 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 Falha do Cron 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, agora é usado um processo em lote.
DEVSOL-1470 Criar o link do 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 tem os seguintes problemas conhecidos:

ID do problema Descrição
DEVSOL-1558
As páginas de métodos do SmartDocs de exemplo da Petstore 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 "Petstore Example".
  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.