Prós e Contras de SwaggerHub

Fácil de integrar com código. Análise coletada por e hospedada no G2.com.

ainda há atualizações em andamento. preciso de um padrão Análise coletada por e hospedada no G2.com.

Estamos documentando a API com. A maneira fácil de integrar e gerar arquivos SDK da API é lidar com todos os parâmetros necessários para a API, como o token de autenticação, etc. O pacote npm OpenAPI ajuda muito a gerar arquivos SDK. Análise coletada por e hospedada no G2.com.

Em relação à segurança, temos grandes preocupações. Como é uma oferta em nuvem, temos que adicionar todos os tokens e credenciais de segurança no portal do hub para verificar se a API está funcionando ou não. Isso pode ser uma ameaça ao adicionar esses detalhes em um site de terceiros. Análise coletada por e hospedada no G2.com.

Gosto de como ele converte o arquivo YAML da documentação da API em um playground de API funcional, incluindo cargas, autorização, etc. E também a versionamento do arquivo de documentos. Análise coletada por e hospedada no G2.com.

Modificar o arquivo YAML para obter o resultado desejado causa dor. Porque a indentação dos arquivos YAML desempenha um papel importante. Se algo não estiver no formato adequado, o documento inteiro entrará em colapso. Análise coletada por e hospedada no G2.com.

Um swagger é na verdade uma ferramenta incrível para documentar automaticamente sua API uma vez que está integrada, ele fornece uma ótima interface de usuário para ver a estrutura e o esquema da API e executa comandos diretamente! Análise coletada por e hospedada no G2.com.

estamos usando sails.js como um framework de backend e integrar o swagger com sails.js é um processo realmente difícil e doloroso, falta de tutoriais na internet e a documentação para integrar com sails não é tão boa na verdade, mas uma vez que está integrado, depois disso funciona suavemente! Análise coletada por e hospedada no G2.com.

Como consumidor de API, você pode extrair as definições de APIs e usá-las. Para qualquer design de API, a documentação é mais crítica do que o código porque todos os desenvolvedores se concentrarão nos documentos; apenas o Swaggerhub tem uma ótima facilidade para construir documentos.

A capacidade de criar organizações é muito útil. Por exemplo, se você está trabalhando para várias organizações, pode facilmente acompanhar seu trabalho de forma independente. Análise coletada por e hospedada no G2.com.

A interface do usuário pode ser confusa para os novos desenvolvedores. Eu vi que algumas das documentações da API contêm caracteres indesejados também. Então, muito trabalho é necessário nessa área. Além disso, o teste da API não é possível. Análise coletada por e hospedada no G2.com.

Torna fácil compartilhar ou usar em conjunto para projetos colaborativos para a equipe e dentro do grupo, também é útil para organizações quando querem documentar a API. Sinto-me elementar ao comunicar sobre a versão do endpoint da API entre várias partes interessadas e equipes usando a seção de comentários do swaggerHub. Swagger Hub é uma plataforma de software de código aberto que qualquer indivíduo ou empresa pode usar gratuitamente. E também pode usar o suporte do swaggerHub para sua equipe, embora o swaggerHub cobre alguns dólares por seus recursos de pacote de equipe e suporte em uma base mensal e anual. Análise coletada por e hospedada no G2.com.

Criar documentação de API do zero não é muito amigável para iniciantes, também há uma falta de teste dos endpoints da API. Ao atualizar ou criar novas entradas de API, não é muito fácil manter a indentação, e levou mais tempo do que o esperado. Análise coletada por e hospedada no G2.com.

Muito fácil compartilhar os documentos relacionados à API sem qualquer intervenção manual. apenas faça a codificação e o documento será gerado automaticamente. Análise coletada por e hospedada no G2.com.

A interface do usuário precisa ser melhorada. Ela deve permitir a configuração de variáveis de ambiente para que, quando houver uma mudança nos detalhes do servidor de implantação, simplesmente se alterem os detalhes das variáveis. Análise coletada por e hospedada no G2.com.

1. A documentação da API principal automatiza a documentação do Swagger UI e fornece todos os detalhes da API, desde a carga útil até a resposta.

2.

3. API segura por meio de suporte de autenticação baseada em token, para que não seja exposta ao mundo exterior. Análise coletada por e hospedada no G2.com.

1. Nada disso, mas difícil de testar OpenApi.

2. Sem ler a documentação, é difícil de usar, mas uma vez que você entende, funciona como um encanto. Análise coletada por e hospedada no G2.com.

Uma ferramenta de documentação de código aberto, gratuita e fácil de usar para a API de onde qualquer pessoa pode verificar e testá-la. A documentação da API é muito fácil, de modo que o código e o documento relacionado serão gerados automaticamente. Análise coletada por e hospedada no G2.com.

Não há como escrever os casos de teste. Melhor se permitir a integração para o software de terceiros. Análise coletada por e hospedada no G2.com.

O que eu mais gosto no SwaggerHub é a possibilidade de usá-lo como um repositório e a capacidade de validar meus scripts ao carregá-los, e o caso de colar no formato JSON ou YAML. Análise coletada por e hospedada no G2.com.

Por enquanto, não encontrei nenhuma desvantagem para mencionar. A verdade funcionou para mim. Análise coletada por e hospedada no G2.com.