API Console V6: documentar definições de RAML e API aberta

API Console V6: documentar definições de RAML e API aberta

API Console V6: documentar definições de RAML e API aberta
cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br


É com prazer que anuncio que uma nova versão do API Console já está disponível. Traz várias alterações e novas ferramentas. Leia mais para saber o que há de novo nesta versão.

O Console da API é um aplicativo que gera automaticamente a documentação para uma API a partir de uma definição de RAML ou API aberta. Isso é feito gerando um modelo de dados AMF, graças ao analisador AMF ou ao módulo “webapi-parser”. O console é construído sobre as APIs da plataforma da Web, para que possa ser facilmente integrado a todos os aplicativos baseados na Web. Ele vem em dois sabores: um aplicativo independente e um componente da web. Dependendo do seu caso de uso, você pode usar qualquer um deles.

O aplicativo independente permite gerar rapidamente a documentação de uma API e executá-la em um servidor da Web como um aplicativo separado. Estamos fornecendo uma ferramenta CLI para gerar o aplicativo a partir de fontes e uma imagem do Docker para simplificar a implantação. O componente da web deve ser usado se você deseja integrar o console a um aplicativo existente. Isso requer mais processo de configuração e desenvolvimento, mas permite maior flexibilidade.

Agora, o Console da API é compatível com WCAG. Durante o processo de desenvolvimento, garantimos que o console esteja acessível para usuários com deficiências. Esta versão é testada por software automatizado e por teste manual.

A interface atualizada implementa as alterações solicitadas por nossos clientes e pela comunidade. A navegação tem uma estrutura ligeiramente diferente e agora renderiza um caminho completo para o recurso, mesmo quando excede o tamanho de um único item de menu de linha. Novos exemplos e widgets de anotação tornam a interface do usuário mais amigável.

Leia Também  Migração no local para Cloudhub | MuleSoft Blog

O editor de solicitações (também conhecido como “try it”) foi redesenhado para simplificar a interação com a API. Agora, apenas processa campos que requerem entrada do usuário para fazer uma solicitação bem-sucedida. Isso significa, por exemplo, que se os cabeçalhos não estiverem definidos para uma operação, eles não serão renderizados.

Com esta versão, adicionamos mais segurança ao limpar os dados de remarcação que estão sendo renderizados. Além disso, a entrada do usuário no editor de solicitações é testada em relação a dados inválidos.

cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br

A maioria das melhorias está relacionada ao desempenho. O tamanho do pacote foi reduzido quase quatro vezes e agora o peso do console da API em pacote é de ~ 300 KB. Isso acelera o tempo de renderização do console e melhora o espaço ocupado pela memória.

Na exibição da documentação, tipos complexos agora estão ocultos por padrão. Isso reduz possíveis falhas quando a documentação possui enormes declarações de tipo. Nas versões anteriores do console, isso causava o travamento das guias. Da mesma forma, grandes exemplos gerados para esses tipos não são destacados por padrão. Anteriormente, seria necessário que o navegador processasse uma quantidade irracional de marcação que travaria a guia por minutos.

A fonte do console foi reescrita para usar os mais recentes padrões da web, que colocam a maior parte do trabalho no navegador, em vez de JavaScript. Isso melhora a experiência geral, pois o console funciona sem problemas, independentemente do tamanho da API. O console ainda funciona com navegadores herdados (até o IE11) com polyfills gerados com o pacote.

Estar o mais próximo possível dos padrões foi a regra nº 1 ao projetar a arquitetura para o API Console e as ferramentas de construção. O console agora segue WC aberto normas para processos de desenvolvimento e construção. O código específico do aplicativo relacionado ao processo de desenvolvimento e construção foi reduzido ao mínimo.

Leia Também  COVID-19: as implicações para as indústrias

O Console da API possui seu próprio módulo de nó e comando da CLI para gerar um pacote configurável em um ambiente de IC ou manualmente. Com esta versão, oferecemos uma imagem do Docker que inclui o API Console, o analisador AMF e um servidor da Web. Os desenvolvedores só precisam passar um projeto de API para gerar um modelo de dados e executar a imagem na sua instância do Kubernetes.

O API Console está e estará em desenvolvimento ativo, pois é um dos principais produtos da plataforma Anypoint enquanto é um projeto de código aberto. O console é testado em um ambiente corporativo e é executado em nuvens públicas e privadas. Ele atende a todos os requisitos para que um aplicativo seja executado na nuvem do governo.

Temos experiência na criação de produtos de documentação da API suportados por vários anos de desenvolvimento do API Console e outros produtos, como o Advanced REST Client. Estamos abertos a sugestões e, ao longo dos anos, ouvimos a voz da comunidade e de nossos clientes. Hoje, estamos orgulhosos do efeito final do nosso trabalho e felizes em compartilhar essa experiência com a comunidade.

Preparamos algumas demos com casos de uso básicos para o API Console. Você pode conferir em demo.api-console.io. Para desenvolvedores, preparamos uma página de documentação em docs.api-console.io.

Experimente o API Console hoje e envie seus comentários. Aceitamos relatórios de problemas e solicitações de recursos na página GitHub do console. Se você é cliente da MuleSoft, pode entrar em contato com o suporte ao cliente e nos enviar seu feedback diretamente.


cupom com desconto - o melhor site de cupom de desconto cupomcomdesconto.com.br
Luiz Presso
Luiz Presso