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

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

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, acesse o suporte ao cliente da Apigee.

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

Novos recursos

Disponibilidade geral do SmartDocs

O SmartDocs está passando 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, inclusive suporte a objetos de segurança com nomes personalizados.
  • Melhorias de design visual nos modelos que geram SmartDocs.
  • Melhorias de usabilidade e fluxo de trabalho no portal do desenvolvedor, disponíveis no menu Conteúdo > SmartDocs no Drupal.
  • O que era conhecido como autenticação por "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 pré-configuradas do cliente SmartDocs.

Para ver mais descrições de recursos, consulte esta postagem do blog (link em inglês).

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

Processo de upgrade do SmartDocs

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

Todas as páginas SmartDocs que já tiverem sido publicadas no seu portal do desenvolvedor continuarão funcionando, mas você precisará seguir o processo de atualização antes de editar ou publicar qualquer alteração em páginas novas ou existentes.

É importante lembrar que, embora seja possível renderizar e publicar SmartDocs dentro do portal do desenvolvedor, os SmartDocs são gerados a partir do modelo de API que reside nos serviços de gerenciamento de APIs Edge da Apigee. Todas as alterações feitas em um modelo de API no Edge serão as mesmas em todos os ambientes do Pantheon (semelhante à forma como os desenvolvedores existem nos ambientes do Pantheon).

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

  1. Atualize e teste a versão 15.05.27 nos seus ambientes dev ou test do 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ê tem mantido seu modelo de API por meio do módulo SmartDocs, exporte como JSON SmartDocs e importe-o 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 as autenticaçãos pré-configuradas 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 CSS e JS e faça alterações para refletir os novos nomes de objeto, como authSchemes e apiSchema. Para informações sobre como atualizar modelos do SmartDocs, consulte Como usar o SmartDocs para documentar APIs.
  6. Renderize novamente e publique 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 Enterprise do Edge e tiver 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 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 do dia na monetização precisa ser configurado 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 americanos.
DEVSOL-603 A página do plano de conflito está mal formatada
Ao comprar um plano que se sobrepõe a um plano atual, a página exibida agora está formatada corretamente 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: parâmetro de modelo de URL não editável após o envio de solicitação com valor vazio
Corrige o problema que torna os parâmetros de 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 Tornar os endereços de e-mail dos usuários do Portal do desenvolvedor editáveis
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 alterar os endereços de e-mail.
DEVSOL-1273 "DevConnect Mint" aparece duas vezes na lista de módulos
Em "Módulos", o "Dev Connect Mint" aparece 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 os arquivos WADL usando URL. Também é possível fazer upload de arquivos Swagger.
DEVSOL-1339 Mudar locais do menu Administrador do SmartDocs
Agora o SmartDocs está no menu de conteúdo, e as configurações do SmartDocs estão no menu Administrador de configurações.
DEVSOL-1340 Remover a versão Beta ao acessar o GA
Agora, o SmartDocs está no menu de conteúdo, e as configurações do Smartdocs estão no menu Administrador 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} Erro fatal: chamada para uma função de membro format() em um objeto que não é em /Applications/MAMP/htdocs/rdnance/doc-profiles/developer-Rate2
DEVSOL-1398 Modelo de petstore do SmartDocs importado na instalação sem comando do usuário
Agora o SmartDocs importa o exemplo de swagger durante a instalação do site (http://petstore.swagger.io/v2/swagger.json) em vez do modelo meteorológico 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, muitos desenvolvedores causavam um problema de tempo limite. Quando uma organização tem mais de 200 usuários, um processo em lote é usado.
DEVSOL-1470 Criar link do menu "APIs" e visualização correspondente
Os SmartDocs do portal de desenvolvedor agora têm um link para a documentação renderizada do SmartDocs no menu principal chamado "APIs", que leva 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 de Petstore em SmartDocs não são renderizadas corretamente em uma nova instalação. Para corrigir esse problema:
  1. Selecione Conteúdo > SmartDocs no menu 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.

Agora, os nós serão renderizados corretamente.