Prós e Contras de Swagger UI

First and formost is, SWagger UI is user-friendly Interface.

Secondly, it generates documentation automatically thus saves time and effort.

Also, it is easy to integrate. Análise coletada por e hospedada no G2.com.

Swagger UI has limited customization available in layouts.

Also, using OAUTH requires extra configuration Análise coletada por e hospedada no G2.com.

Fácil de implementar e publicar.

Vem com json pré-preenchido (json gerado automaticamente)

A documentação torna-se automatizada

Importante para engenheiros de frontend, backend e produto Análise coletada por e hospedada no G2.com.

Há acordeões usados, então você precisa rolar para baixo e abrir os acordeões para ver, para cada endpoint.

Então, um botão no topo para abrir todos os acordeões juntos pode ser melhor.

A UX pode ser ainda mais melhorada, mantendo uma gaveta de glossário (Tabela de conteúdo) à direita e o corpo principal do conteúdo pode estar no centro exibindo o endpoint. Assim, pode-se facilmente mudar para outro clicando na Tabela de Conteúdo.

Então, basicamente, a UX pode ser melhorada. Análise coletada por e hospedada no G2.com.

Sua interface de usuário e forma de aplicação são muito boas. Além disso, é muito fácil de implementar. Análise coletada por e hospedada no G2.com.

Nada, é uma boa aplicação para testes de API. Análise coletada por e hospedada no G2.com.

Swagger fornece a documentação das APIs de maneira interativa com tudo o que é necessário para documentar, por exemplo, tipo de API como GET, POST, DELETE, PUT, PATCH etc., e endpoint de cada API, parâmetros de solicitação e resposta e tipo de resposta, por exemplo, 400, 200, 401 etc. Tudo é colocado em um só lugar de maneira bem organizada e bonita. A melhor parte é que é fácil de usar e integrar com sua ferramenta, por exemplo, Spring Boot, você só precisa adicionar a configuração e tudo é documentado automaticamente. Ele até fornece acesso baseado em token para as APIs, o que as torna seguras, pois ninguém pode usá-las sem um token adequado. Sua interface é amigável e você pode personalizá-la. Você pode hospedar suas APIs com a documentação do Swagger, o que melhora a experiência do desenvolvedor e torna a melhor documentação facilmente disponível sem muito esforço. Eu adoro essa documentação de APIs e nunca procurei outra ferramenta desde que comecei a usá-la. Análise coletada por e hospedada no G2.com.

estou usando há 2,5 anos e não encontrei nada para não gostar no swagger. adoro usá-lo. Análise coletada por e hospedada no G2.com.

Melhor descoberta de API,

Automação de API mais rápida

Manutenção reduzida de documentação Análise coletada por e hospedada no G2.com.

Curva de aprendizado acentuada,

Complexidade de configuração

Problemas de desempenho Análise coletada por e hospedada no G2.com.

The best thing I personally like about swagger the UI/UX.

It has its own unique way of presenting the Rest API operation using unique colours for each of the operations (GET: blue, POST: green, PUT: yellow and DELETE: red). Also we can provide proper example of the schemas/structure for each type of error codes, which inturn helps user to understand the operations more easily Análise coletada por e hospedada no G2.com.

As far as I know I havent come across any major point that I have disliked. One of the minor point I've noticed is that if we havnt performed any operations for a long time, it is usually timedout. But the frontend user would not know and it just provides a 401 code without any extra validation. This misleads the user that he doesnt have the permission to perform the action. Instead we should just re-authenticate. Análise coletada por e hospedada no G2.com.

I don't know of a single alternative to Swagger UI for documenting & testing APIs that is as feature-rich.

1. Has in-build API testing which supports authentication custom payloads.

2. Can easily see all the different types of response models, errors - a server can return.

3. Has a big developer community around it & a lot of libraries for integration in Django, express, ruby on rails, etc. Análise coletada por e hospedada no G2.com.

Would really like if there was a sort-of drag-and-drop for simple APIs that can output static swagger ui HTML, CSS, JS files that I can easily host on something like GitHub pages. Without having to write the complete OpenAPI spec. Análise coletada por e hospedada no G2.com.

Swagger é a plataforma onde uma pessoa sem conhecimento pode experimentar Testes de API mesmo sem saber tudo sobre JSON e XML. Análise coletada por e hospedada no G2.com.

Se estou gerando um token de autenticação e depois preciso obter alguns dados em um módulo diferente. A mudança do primeiro para o segundo está travando ou lenta. Em alguns casos, preciso fechar o navegador e reiniciá-lo novamente. Isso está impactando a produtividade em um dia agitado. Análise coletada por e hospedada no G2.com.

Swagger UI é o melhor para documentação de API, além disso, você pode testar suas APIs e a melhor característica, posso dizer, é que ele aceita token para autenticação. Análise coletada por e hospedada no G2.com.

Deve haver uma mensagem de erro adequada quando há algum problema com a interface do Swagger devido ao código. Análise coletada por e hospedada no G2.com.

It simplifies for the users to get the info and work on it at one go... helps collaboration with other teams or members to use our team API s. I use it everytime for every application I develop on to help others understand it.It has easy library imports for Go and for python as well. Pretty easy to implement. Análise coletada por e hospedada no G2.com.

nothing to dislike .. makes developers' everyday life easy. I use it atleast once per week to write for the apis I use... never felt difficulty in self understanding. Swagger UI team supports customers to preview as well. Análise coletada por e hospedada no G2.com.